Class ImportProductsRequest.Builder (2.4.0)

Version 2.4.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public static final class ImportProductsRequest.Builder extends GeneratedMessageV3.Builder<ImportProductsRequest.Builder> implements ImportProductsRequestOrBuilder

Request message for Import methods.

Protobuf type google.cloud.retail.v2alpha.ImportProductsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ImportProductsRequest.Builder

Implements

ImportProductsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ImportProductsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ImportProductsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ImportProductsRequest build()

Returns

Type	Description
ImportProductsRequest

buildPartial()

public ImportProductsRequest buildPartial()

Returns

Type	Description
ImportProductsRequest

clear()

public ImportProductsRequest.Builder clear()

Returns

Type	Description
ImportProductsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearErrorsConfig()

public ImportProductsRequest.Builder clearErrorsConfig()

The desired location of errors incurred during the Import.

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

Returns

Type	Description
ImportProductsRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ImportProductsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ImportProductsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearInputConfig()

public ImportProductsRequest.Builder clearInputConfig()

Required. The desired input location of the data.

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

Returns

Type	Description
ImportProductsRequest.Builder

clearNotificationPubsubTopic()

public ImportProductsRequest.Builder clearNotificationPubsubTopic()

Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}. It has to be within the same project as ImportProductsRequest.parent. Make sure that both [e-mail] and service-<project number>@gcp-sa-retail.iam.gserviceaccount.com have the pubsub.topics.publish IAM permission on the topic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

string notification_pubsub_topic = 7;

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ImportProductsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ImportProductsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParent()

public ImportProductsRequest.Builder clearParent()

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) = { ... }

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

clearReconciliationMode()

public ImportProductsRequest.Builder clearReconciliationMode()

The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.

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

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

clearRequestId() (deprecated)

public ImportProductsRequest.Builder clearRequestId()

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

Deprecated. This field has no effect.

string request_id = 6 [deprecated = true];

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

clearSkipDefaultBranchProtection()

public ImportProductsRequest.Builder clearSkipDefaultBranchProtection()

If true, will perform the FULL import even if it would delete a large proportion of the products in the default branch, which could potentially cause outages if you have live predict/search traffic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

bool skip_default_branch_protection = 8;

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

clearUpdateMask()

public ImportProductsRequest.Builder clearUpdateMask()

Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.

.google.protobuf.FieldMask update_mask = 4;

Returns

Type	Description
ImportProductsRequest.Builder

clone()

public ImportProductsRequest.Builder clone()

Returns

Type	Description
ImportProductsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ImportProductsRequest getDefaultInstanceForType()

Returns

Type	Description
ImportProductsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getErrorsConfig()

public ImportErrorsConfig getErrorsConfig()

The desired location of errors incurred during the Import.

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

Returns

Type	Description
ImportErrorsConfig	The errorsConfig.

getErrorsConfigBuilder()

public ImportErrorsConfig.Builder getErrorsConfigBuilder()

The desired location of errors incurred during the Import.

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

Returns

Type	Description
ImportErrorsConfig.Builder

getErrorsConfigOrBuilder()

public ImportErrorsConfigOrBuilder getErrorsConfigOrBuilder()

The desired location of errors incurred during the Import.

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

Returns

Type	Description
ImportErrorsConfigOrBuilder

getInputConfig()

public ProductInputConfig getInputConfig()

Required. The desired input location of the data.

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

Returns

Type	Description
ProductInputConfig	The inputConfig.

getInputConfigBuilder()

public ProductInputConfig.Builder getInputConfigBuilder()

Required. The desired input location of the data.

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

Returns

Type	Description
ProductInputConfig.Builder

getInputConfigOrBuilder()

public ProductInputConfigOrBuilder getInputConfigOrBuilder()

Required. The desired input location of the data.

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

Returns

Type	Description
ProductInputConfigOrBuilder

getNotificationPubsubTopic()

public String getNotificationPubsubTopic()

Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}. It has to be within the same project as ImportProductsRequest.parent. Make sure that both [e-mail] and service-<project number>@gcp-sa-retail.iam.gserviceaccount.com have the pubsub.topics.publish IAM permission on the topic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

string notification_pubsub_topic = 7;

Returns

Type	Description
String	The notificationPubsubTopic.

getNotificationPubsubTopicBytes()

public ByteString getNotificationPubsubTopicBytes()

Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}. It has to be within the same project as ImportProductsRequest.parent. Make sure that both [e-mail] and service-<project number>@gcp-sa-retail.iam.gserviceaccount.com have the pubsub.topics.publish IAM permission on the topic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

string notification_pubsub_topic = 7;

Returns

Type	Description
ByteString	The bytes for notificationPubsubTopic.

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) = { ... }

Returns

Type	Description
String	The parent.

getParentBytes()

public 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) = { ... }

Returns

Type	Description
ByteString	The bytes for parent.

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.v2alpha.ImportProductsRequest.ReconciliationMode reconciliation_mode = 5;

Returns

Type	Description
ImportProductsRequest.ReconciliationMode	The reconciliationMode.

getReconciliationModeValue()

public int getReconciliationModeValue()

The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.

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

Returns

Type	Description
int	The enum numeric value on the wire for reconciliationMode.

getRequestId() (deprecated)

public String getRequestId()

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

Deprecated. This field has no effect.

string request_id = 6 [deprecated = true];

Returns

Type	Description
String	The requestId.

getRequestIdBytes() (deprecated)

public ByteString getRequestIdBytes()

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

Deprecated. This field has no effect.

string request_id = 6 [deprecated = true];

Returns

Type	Description
ByteString	The bytes for requestId.

getSkipDefaultBranchProtection()

public boolean getSkipDefaultBranchProtection()

If true, will perform the FULL import even if it would delete a large proportion of the products in the default branch, which could potentially cause outages if you have live predict/search traffic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

bool skip_default_branch_protection = 8;

Returns

Type	Description
boolean	The skipDefaultBranchProtection.

getUpdateMask()

public FieldMask getUpdateMask()

Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.

.google.protobuf.FieldMask update_mask = 4;

Returns

Type	Description
FieldMask	The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.

.google.protobuf.FieldMask update_mask = 4;

Returns

Type	Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.

.google.protobuf.FieldMask update_mask = 4;

Returns

Type	Description
FieldMaskOrBuilder

hasErrorsConfig()

public boolean hasErrorsConfig()

The desired location of errors incurred during the Import.

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

Returns

Type	Description
boolean	Whether the errorsConfig field is set.

hasInputConfig()

public boolean hasInputConfig()

Required. The desired input location of the data.

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

Returns

Type	Description
boolean	Whether the inputConfig field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.

.google.protobuf.FieldMask update_mask = 4;

Returns

Type	Description
boolean	Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeErrorsConfig(ImportErrorsConfig value)

public ImportProductsRequest.Builder mergeErrorsConfig(ImportErrorsConfig value)

The desired location of errors incurred during the Import.

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

Parameter

Name	Description
value	ImportErrorsConfig

Returns

Type	Description
ImportProductsRequest.Builder

mergeFrom(ImportProductsRequest other)

public ImportProductsRequest.Builder mergeFrom(ImportProductsRequest other)

Parameter

Name	Description
other	ImportProductsRequest

Returns

Type	Description
ImportProductsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImportProductsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ImportProductsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ImportProductsRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
ImportProductsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeInputConfig(ProductInputConfig value)

public ImportProductsRequest.Builder mergeInputConfig(ProductInputConfig value)

Required. The desired input location of the data.

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

Parameter

Name	Description
value	ProductInputConfig

Returns

Type	Description
ImportProductsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ImportProductsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ImportProductsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateMask(FieldMask value)

public ImportProductsRequest.Builder mergeUpdateMask(FieldMask value)

Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.

.google.protobuf.FieldMask update_mask = 4;

Parameter

Name	Description
value	FieldMask

Returns

Type	Description
ImportProductsRequest.Builder

setErrorsConfig(ImportErrorsConfig value)

public ImportProductsRequest.Builder setErrorsConfig(ImportErrorsConfig value)

The desired location of errors incurred during the Import.

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

Parameter

Name	Description
value	ImportErrorsConfig

Returns

Type	Description
ImportProductsRequest.Builder

setErrorsConfig(ImportErrorsConfig.Builder builderForValue)

public ImportProductsRequest.Builder setErrorsConfig(ImportErrorsConfig.Builder builderForValue)

The desired location of errors incurred during the Import.

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

Parameter

Name	Description
builderForValue	ImportErrorsConfig.Builder

Returns

Type	Description
ImportProductsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ImportProductsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ImportProductsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setInputConfig(ProductInputConfig value)

public ImportProductsRequest.Builder setInputConfig(ProductInputConfig value)

Required. The desired input location of the data.

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

Parameter

Name	Description
value	ProductInputConfig

Returns

Type	Description
ImportProductsRequest.Builder

setInputConfig(ProductInputConfig.Builder builderForValue)

public ImportProductsRequest.Builder setInputConfig(ProductInputConfig.Builder builderForValue)

Required. The desired input location of the data.

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

Parameter

Name	Description
builderForValue	ProductInputConfig.Builder

Returns

Type	Description
ImportProductsRequest.Builder

setNotificationPubsubTopic(String value)

public ImportProductsRequest.Builder setNotificationPubsubTopic(String value)

Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}. It has to be within the same project as ImportProductsRequest.parent. Make sure that both [e-mail] and service-<project number>@gcp-sa-retail.iam.gserviceaccount.com have the pubsub.topics.publish IAM permission on the topic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

string notification_pubsub_topic = 7;

Parameter

Name	Description
value	String The notificationPubsubTopic to set.

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

setNotificationPubsubTopicBytes(ByteString value)

public ImportProductsRequest.Builder setNotificationPubsubTopicBytes(ByteString value)

Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}. It has to be within the same project as ImportProductsRequest.parent. Make sure that both [e-mail] and service-<project number>@gcp-sa-retail.iam.gserviceaccount.com have the pubsub.topics.publish IAM permission on the topic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

string notification_pubsub_topic = 7;

Parameter

Name	Description
value	ByteString The bytes for notificationPubsubTopic to set.

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

setParent(String value)

public ImportProductsRequest.Builder setParent(String value)

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) = { ... }

Parameter

Name	Description
value	String The parent to set.

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public ImportProductsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter

Name	Description
value	ByteString The bytes for parent to set.

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

setReconciliationMode(ImportProductsRequest.ReconciliationMode value)

public ImportProductsRequest.Builder setReconciliationMode(ImportProductsRequest.ReconciliationMode value)

The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.

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

Parameter

Name	Description
value	ImportProductsRequest.ReconciliationMode The reconciliationMode to set.

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

setReconciliationModeValue(int value)

public ImportProductsRequest.Builder setReconciliationModeValue(int value)

The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.

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

Parameter

Name	Description
value	int The enum numeric value on the wire for reconciliationMode to set.

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ImportProductsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
ImportProductsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRequestId(String value) (deprecated)

public ImportProductsRequest.Builder setRequestId(String value)

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

Deprecated. This field has no effect.

string request_id = 6 [deprecated = true];

Parameter

Name	Description
value	String The requestId to set.

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

setRequestIdBytes(ByteString value) (deprecated)

public ImportProductsRequest.Builder setRequestIdBytes(ByteString value)

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

Deprecated. This field has no effect.

string request_id = 6 [deprecated = true];

Parameter

Name	Description
value	ByteString The bytes for requestId to set.

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

setSkipDefaultBranchProtection(boolean value)

public ImportProductsRequest.Builder setSkipDefaultBranchProtection(boolean value)

If true, will perform the FULL import even if it would delete a large proportion of the products in the default branch, which could potentially cause outages if you have live predict/search traffic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

bool skip_default_branch_protection = 8;

Parameter

Name	Description
value	boolean The skipDefaultBranchProtection to set.

Returns

Type	Description
ImportProductsRequest.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ImportProductsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ImportProductsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateMask(FieldMask value)

public ImportProductsRequest.Builder setUpdateMask(FieldMask value)

Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.

.google.protobuf.FieldMask update_mask = 4;

Parameter

Name	Description
value	FieldMask

Returns

Type	Description
ImportProductsRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public ImportProductsRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.

.google.protobuf.FieldMask update_mask = 4;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
ImportProductsRequest.Builder