com.google.cloud.retail.v2alpha

Interface ImportProductsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ImportProductsRequest, ImportProductsRequest.Builder

public interface ImportProductsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.v2alpha.ImportProductsRequest.request_id is deprecated. See google/cloud/retail/v2alpha/import_config.proto;l=189
com.google.protobuf.ByteString	getRequestIdBytes() Deprecated. google.cloud.retail.v2alpha.ImportProductsRequest.request_id is deprecated. See google/cloud/retail/v2alpha/import_config.proto;l=189
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.
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.
boolean	hasInputConfig() Required.
boolean	hasUpdateMask() Indicates which fields in the provided imported `products` to update.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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:

The parent.

getParentBytes

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

Returns:

The bytes for parent.

getRequestId

@Deprecated
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];

Returns:

The requestId.

getRequestIdBytes

@Deprecated
com.google.protobuf.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];

Returns:

The bytes for requestId.

hasInputConfig

boolean hasInputConfig()

 Required. The desired input location of the data.
 

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

Returns:

Whether the inputConfig field is set.

getInputConfig

ProductInputConfig getInputConfig()

 Required. The desired input location of the data.
 

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

Returns:

The inputConfig.

getInputConfigOrBuilder

ProductInputConfigOrBuilder getInputConfigOrBuilder()

 Required. The desired input location of the data.
 

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

hasErrorsConfig

boolean hasErrorsConfig()

 The desired location of errors incurred during the Import.
 

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

Returns:

Whether the errorsConfig field is set.

getErrorsConfig

ImportErrorsConfig getErrorsConfig()

 The desired location of errors incurred during the Import.
 

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

Returns:

The errorsConfig.

getErrorsConfigOrBuilder

ImportErrorsConfigOrBuilder getErrorsConfigOrBuilder()

 The desired location of errors incurred during the Import.
 

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

hasUpdateMask

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;

Returns:

Whether the updateMask field is set.

getUpdateMask

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;

Returns:

The updateMask.

getUpdateMaskOrBuilder

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;

getReconciliationModeValue

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.INCREMENTAL].
 

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

Returns:

The enum numeric value on the wire for reconciliationMode.

getReconciliationMode

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.INCREMENTAL].
 

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

Returns:

The reconciliationMode.

getNotificationPubsubTopic

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.v2alpha.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;

Returns:

The notificationPubsubTopic.

getNotificationPubsubTopicBytes

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.v2alpha.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;

Returns:

The bytes for notificationPubsubTopic.

getSkipDefaultBranchProtection

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][google.cloud.retail.v2alpha.ImportProductsRequest.reconciliation_mode]
 is set to `FULL`.
 

bool skip_default_branch_protection = 8;

Returns:

The skipDefaultBranchProtection.