com.google.cloud.retail.v2

Class ImportProductsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2.ImportProductsRequest

All Implemented Interfaces:

ImportProductsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ImportProductsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ImportProductsRequestOrBuilder

 Request message for Import methods.
 

Protobuf type google.cloud.retail.v2.ImportProductsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImportProductsRequest.Builder Request message for Import methods.
static class	ImportProductsRequest.ReconciliationMode Indicates how imported products are reconciled with the existing products created or imported before.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERRORS_CONFIG_FIELD_NUMBER
static int	INPUT_CONFIG_FIELD_NUMBER
static int	NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER
static int	RECONCILIATION_MODE_FIELD_NUMBER
static int	REQUEST_ID_FIELD_NUMBER
static int	UPDATE_MASK_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ImportProductsRequest	getDefaultInstance()
ImportProductsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
ImportErrorsConfig	getErrorsConfig() The desired location of errors incurred during the Import.
ImportErrorsConfigOrBuilder	getErrorsConfigOrBuilder() The desired location of errors incurred during the Import.
ProductInputConfig	getInputConfig() Required.
ProductInputConfigOrBuilder	getInputConfigOrBuilder() Required.
String	getNotificationPubsubTopic() Full Pub/Sub topic name for receiving notification.
com.google.protobuf.ByteString	getNotificationPubsubTopicBytes() Full Pub/Sub topic name for receiving notification.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<ImportProductsRequest>	getParserForType()
ImportProductsRequest.ReconciliationMode	getReconciliationMode() The mode of reconciliation between existing products and the products to be imported.
int	getReconciliationModeValue() The mode of reconciliation between existing products and the products to be imported.
String	getRequestId() Deprecated. google.cloud.retail.v2.ImportProductsRequest.request_id is deprecated. See google/cloud/retail/v2/import_config.proto;l=189
com.google.protobuf.ByteString	getRequestIdBytes() Deprecated. google.cloud.retail.v2.ImportProductsRequest.request_id is deprecated. See google/cloud/retail/v2/import_config.proto;l=189
int	getSerializedSize()
com.google.protobuf.FieldMask	getUpdateMask() Indicates which fields in the provided imported `products` to update.
com.google.protobuf.FieldMaskOrBuilder	getUpdateMaskOrBuilder() Indicates which fields in the provided imported `products` to update.
boolean	hasErrorsConfig() The desired location of errors incurred during the Import.
int	hashCode()
boolean	hasInputConfig() Required.
boolean	hasUpdateMask() Indicates which fields in the provided imported `products` to update.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ImportProductsRequest.Builder	newBuilder()
static ImportProductsRequest.Builder	newBuilder(ImportProductsRequest prototype)
ImportProductsRequest.Builder	newBuilderForType()
protected ImportProductsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ImportProductsRequest	parseDelimitedFrom(InputStream input)
static ImportProductsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ImportProductsRequest	parseFrom(byte[] data)
static ImportProductsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ImportProductsRequest	parseFrom(ByteBuffer data)
static ImportProductsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ImportProductsRequest	parseFrom(com.google.protobuf.ByteString data)
static ImportProductsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ImportProductsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ImportProductsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ImportProductsRequest	parseFrom(InputStream input)
static ImportProductsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ImportProductsRequest>	parser()
ImportProductsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER

See Also:

Constant Field Values

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

ERRORS_CONFIG_FIELD_NUMBER

public static final int ERRORS_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER

See Also:

Constant Field Values

RECONCILIATION_MODE_FIELD_NUMBER

public static final int RECONCILIATION_MODE_FIELD_NUMBER

See Also:

Constant Field Values

NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER

public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getParent

public String getParent()

 Required.
 `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch`

 If no updateMask is specified, requires products.create permission.
 If updateMask is specified, requires products.update permission.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParent in interface ImportProductsRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required.
 `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch`

 If no updateMask is specified, requires products.create permission.
 If updateMask is specified, requires products.update permission.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParentBytes in interface ImportProductsRequestOrBuilder

Returns:

The bytes for parent.

getRequestId

@Deprecated
public String getRequestId()

Deprecated. google.cloud.retail.v2.ImportProductsRequest.request_id is deprecated. See google/cloud/retail/v2/import_config.proto;l=189

 Deprecated. This field has no effect.
 

string request_id = 6 [deprecated = true];

Specified by:

getRequestId in interface ImportProductsRequestOrBuilder

Returns:

The requestId.

getRequestIdBytes

@Deprecated
public com.google.protobuf.ByteString getRequestIdBytes()

Deprecated. google.cloud.retail.v2.ImportProductsRequest.request_id is deprecated. See google/cloud/retail/v2/import_config.proto;l=189

 Deprecated. This field has no effect.
 

string request_id = 6 [deprecated = true];

Specified by:

getRequestIdBytes in interface ImportProductsRequestOrBuilder

Returns:

The bytes for requestId.

hasInputConfig

public boolean hasInputConfig()

 Required. The desired input location of the data.
 

.google.cloud.retail.v2.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasInputConfig in interface ImportProductsRequestOrBuilder

Returns:

Whether the inputConfig field is set.

getInputConfig

public ProductInputConfig getInputConfig()

 Required. The desired input location of the data.
 

.google.cloud.retail.v2.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInputConfig in interface ImportProductsRequestOrBuilder

Returns:

The inputConfig.

getInputConfigOrBuilder

public ProductInputConfigOrBuilder getInputConfigOrBuilder()

 Required. The desired input location of the data.
 

.google.cloud.retail.v2.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getInputConfigOrBuilder in interface ImportProductsRequestOrBuilder

hasErrorsConfig

public boolean hasErrorsConfig()

 The desired location of errors incurred during the Import.
 

.google.cloud.retail.v2.ImportErrorsConfig errors_config = 3;

Specified by:

hasErrorsConfig in interface ImportProductsRequestOrBuilder

Returns:

Whether the errorsConfig field is set.

getErrorsConfig

public ImportErrorsConfig getErrorsConfig()

 The desired location of errors incurred during the Import.
 

.google.cloud.retail.v2.ImportErrorsConfig errors_config = 3;

Specified by:

getErrorsConfig in interface ImportProductsRequestOrBuilder

Returns:

The errorsConfig.

getErrorsConfigOrBuilder

public ImportErrorsConfigOrBuilder getErrorsConfigOrBuilder()

 The desired location of errors incurred during the Import.
 

.google.cloud.retail.v2.ImportErrorsConfig errors_config = 3;

Specified by:

getErrorsConfigOrBuilder in interface ImportProductsRequestOrBuilder

hasUpdateMask

public boolean hasUpdateMask()

 Indicates which fields in the provided imported `products` to update. If
 not set, all fields are updated.
 

.google.protobuf.FieldMask update_mask = 4;

Specified by:

hasUpdateMask in interface ImportProductsRequestOrBuilder

Returns:

Whether the updateMask field is set.

getUpdateMask

public com.google.protobuf.FieldMask getUpdateMask()

 Indicates which fields in the provided imported `products` to update. If
 not set, all fields are updated.
 

.google.protobuf.FieldMask update_mask = 4;

Specified by:

getUpdateMask in interface ImportProductsRequestOrBuilder

Returns:

The updateMask.

getUpdateMaskOrBuilder

public com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()

 Indicates which fields in the provided imported `products` to update. If
 not set, all fields are updated.
 

.google.protobuf.FieldMask update_mask = 4;

Specified by:

getUpdateMaskOrBuilder in interface ImportProductsRequestOrBuilder

getReconciliationModeValue

public int getReconciliationModeValue()

 The mode of reconciliation between existing products and the products to be
 imported. Defaults to
 [ReconciliationMode.INCREMENTAL][google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode.INCREMENTAL].
 

.google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode reconciliation_mode = 5;

Specified by:

getReconciliationModeValue in interface ImportProductsRequestOrBuilder

Returns:

The enum numeric value on the wire for reconciliationMode.

getReconciliationMode

public ImportProductsRequest.ReconciliationMode getReconciliationMode()

 The mode of reconciliation between existing products and the products to be
 imported. Defaults to
 [ReconciliationMode.INCREMENTAL][google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode.INCREMENTAL].
 

.google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode reconciliation_mode = 5;

Specified by:

getReconciliationMode in interface ImportProductsRequestOrBuilder

Returns:

The reconciliationMode.

getNotificationPubsubTopic

public String getNotificationPubsubTopic()

 Full Pub/Sub topic name for receiving notification. If this field is set,
 when the import is finished, a notification is sent to
 specified Pub/Sub topic. The message data is JSON string of a
 [Operation][google.longrunning.Operation].

 Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has
 to be within the same project as
 [ImportProductsRequest.parent][google.cloud.retail.v2.ImportProductsRequest.parent].
 Make sure that `service-<project
 number>@gcp-sa-retail.iam.gserviceaccount.com` has the
 `pubsub.topics.publish` IAM permission on the topic.
 

string notification_pubsub_topic = 7;

Specified by:

getNotificationPubsubTopic in interface ImportProductsRequestOrBuilder

Returns:

The notificationPubsubTopic.

getNotificationPubsubTopicBytes

public com.google.protobuf.ByteString getNotificationPubsubTopicBytes()

 Full Pub/Sub topic name for receiving notification. If this field is set,
 when the import is finished, a notification is sent to
 specified Pub/Sub topic. The message data is JSON string of a
 [Operation][google.longrunning.Operation].

 Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has
 to be within the same project as
 [ImportProductsRequest.parent][google.cloud.retail.v2.ImportProductsRequest.parent].
 Make sure that `service-<project
 number>@gcp-sa-retail.iam.gserviceaccount.com` has the
 `pubsub.topics.publish` IAM permission on the topic.
 

string notification_pubsub_topic = 7;

Specified by:

getNotificationPubsubTopicBytes in interface ImportProductsRequestOrBuilder

Returns:

The bytes for notificationPubsubTopic.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ImportProductsRequest parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportProductsRequest parseFrom(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportProductsRequest parseFrom(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportProductsRequest parseFrom(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportProductsRequest parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportProductsRequest parseFrom(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ImportProductsRequest parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static ImportProductsRequest parseFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static ImportProductsRequest parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static ImportProductsRequest parseDelimitedFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseFrom

public static ImportProductsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static ImportProductsRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

newBuilderForType

public ImportProductsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ImportProductsRequest.Builder newBuilder()

newBuilder

public static ImportProductsRequest.Builder newBuilder(ImportProductsRequest prototype)

toBuilder

public ImportProductsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ImportProductsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ImportProductsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ImportProductsRequest> parser()

getParserForType

public com.google.protobuf.Parser<ImportProductsRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ImportProductsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder