- 2.55.0 (latest)
- 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.BuilderImplements
ImportProductsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ImportProductsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
ImportProductsRequest.Builder |
build()
public ImportProductsRequest build()
Type | Description |
ImportProductsRequest |
buildPartial()
public ImportProductsRequest buildPartial()
Type | Description |
ImportProductsRequest |
clear()
public ImportProductsRequest.Builder clear()
Type | Description |
ImportProductsRequest.Builder |
clearErrorsConfig()
public ImportProductsRequest.Builder clearErrorsConfig()
The desired location of errors incurred during the Import.
.google.cloud.retail.v2alpha.ImportErrorsConfig errors_config = 3;
Type | Description |
ImportProductsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ImportProductsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
ImportProductsRequest.Builder |
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];
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 is sent to
specified Pub/Sub topic. The message data is 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 service-<project
number>@gcp-sa-retail.iam.gserviceaccount.com
has the
pubsub.topics.publish
IAM permission on the topic.
string notification_pubsub_topic = 7;
Type | Description |
ImportProductsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ImportProductsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
ImportProductsRequest.Builder |
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) = { ... }
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;
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=189
Deprecated. This field has no effect.
string request_id = 6 [deprecated = true];
Type | Description |
ImportProductsRequest.Builder | This builder for chaining. |
clearSkipDefaultBranchProtection()
public ImportProductsRequest.Builder clearSkipDefaultBranchProtection()
If true, this performs 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;
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, all fields are updated.
.google.protobuf.FieldMask update_mask = 4;
Type | Description |
ImportProductsRequest.Builder |
clone()
public ImportProductsRequest.Builder clone()
Type | Description |
ImportProductsRequest.Builder |
getDefaultInstanceForType()
public ImportProductsRequest getDefaultInstanceForType()
Type | Description |
ImportProductsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getErrorsConfig()
public ImportErrorsConfig getErrorsConfig()
The desired location of errors incurred during the Import.
.google.cloud.retail.v2alpha.ImportErrorsConfig errors_config = 3;
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;
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;
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];
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];
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];
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 is sent to
specified Pub/Sub topic. The message data is 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 service-<project
number>@gcp-sa-retail.iam.gserviceaccount.com
has the
pubsub.topics.publish
IAM permission on the topic.
string notification_pubsub_topic = 7;
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 is sent to
specified Pub/Sub topic. The message data is 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 service-<project
number>@gcp-sa-retail.iam.gserviceaccount.com
has the
pubsub.topics.publish
IAM permission on the topic.
string notification_pubsub_topic = 7;
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) = { ... }
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) = { ... }
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;
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;
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=189
Deprecated. This field has no effect.
string request_id = 6 [deprecated = true];
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=189
Deprecated. This field has no effect.
string request_id = 6 [deprecated = true];
Type | Description |
ByteString | The bytes for requestId. |
getSkipDefaultBranchProtection()
public boolean getSkipDefaultBranchProtection()
If true, this performs 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;
Type | Description |
boolean | The skipDefaultBranchProtection. |
getUpdateMask()
public 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;
Type | Description |
FieldMask | The updateMask. |
getUpdateMaskBuilder()
public FieldMask.Builder getUpdateMaskBuilder()
Indicates which fields in the provided imported products
to update. If
not set, all fields are updated.
.google.protobuf.FieldMask update_mask = 4;
Type | Description |
Builder |
getUpdateMaskOrBuilder()
public 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;
Type | Description |
FieldMaskOrBuilder |
hasErrorsConfig()
public boolean hasErrorsConfig()
The desired location of errors incurred during the Import.
.google.cloud.retail.v2alpha.ImportErrorsConfig errors_config = 3;
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];
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, all fields are updated.
.google.protobuf.FieldMask update_mask = 4;
Type | Description |
boolean | Whether the updateMask field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
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;
Name | Description |
value | ImportErrorsConfig |
Type | Description |
ImportProductsRequest.Builder |
mergeFrom(ImportProductsRequest other)
public ImportProductsRequest.Builder mergeFrom(ImportProductsRequest other)
Name | Description |
other | ImportProductsRequest |
Type | Description |
ImportProductsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ImportProductsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
ImportProductsRequest.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public ImportProductsRequest.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
ImportProductsRequest.Builder |
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];
Name | Description |
value | ProductInputConfig |
Type | Description |
ImportProductsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ImportProductsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
ImportProductsRequest.Builder |
mergeUpdateMask(FieldMask value)
public ImportProductsRequest.Builder mergeUpdateMask(FieldMask value)
Indicates which fields in the provided imported products
to update. If
not set, all fields are updated.
.google.protobuf.FieldMask update_mask = 4;
Name | Description |
value | FieldMask |
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;
Name | Description |
value | ImportErrorsConfig |
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;
Name | Description |
builderForValue | ImportErrorsConfig.Builder |
Type | Description |
ImportProductsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ImportProductsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
ImportProductsRequest.Builder |
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];
Name | Description |
value | ProductInputConfig |
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];
Name | Description |
builderForValue | ProductInputConfig.Builder |
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 is sent to
specified Pub/Sub topic. The message data is 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 service-<project
number>@gcp-sa-retail.iam.gserviceaccount.com
has the
pubsub.topics.publish
IAM permission on the topic.
string notification_pubsub_topic = 7;
Name | Description |
value | String The notificationPubsubTopic to set. |
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 is sent to
specified Pub/Sub topic. The message data is 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 service-<project
number>@gcp-sa-retail.iam.gserviceaccount.com
has the
pubsub.topics.publish
IAM permission on the topic.
string notification_pubsub_topic = 7;
Name | Description |
value | ByteString The bytes for notificationPubsubTopic to set. |
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) = { ... }
Name | Description |
value | String The parent to set. |
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) = { ... }
Name | Description |
value | ByteString The bytes for parent to set. |
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;
Name | Description |
value | ImportProductsRequest.ReconciliationMode The reconciliationMode to set. |
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;
Name | Description |
value | int The enum numeric value on the wire for reconciliationMode to set. |
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)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
ImportProductsRequest.Builder |
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=189
Deprecated. This field has no effect.
string request_id = 6 [deprecated = true];
Name | Description |
value | String The requestId to set. |
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=189
Deprecated. This field has no effect.
string request_id = 6 [deprecated = true];
Name | Description |
value | ByteString The bytes for requestId to set. |
Type | Description |
ImportProductsRequest.Builder | This builder for chaining. |
setSkipDefaultBranchProtection(boolean value)
public ImportProductsRequest.Builder setSkipDefaultBranchProtection(boolean value)
If true, this performs 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;
Name | Description |
value | boolean The skipDefaultBranchProtection to set. |
Type | Description |
ImportProductsRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ImportProductsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
ImportProductsRequest.Builder |
setUpdateMask(FieldMask value)
public ImportProductsRequest.Builder setUpdateMask(FieldMask value)
Indicates which fields in the provided imported products
to update. If
not set, all fields are updated.
.google.protobuf.FieldMask update_mask = 4;
Name | Description |
value | FieldMask |
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, all fields are updated.
.google.protobuf.FieldMask update_mask = 4;
Name | Description |
builderForValue | Builder |
Type | Description |
ImportProductsRequest.Builder |