public interface ImportProductsRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getErrorsConfig()
public abstract ImportErrorsConfig getErrorsConfig()
The desired location of errors incurred during the Import.
.google.cloud.retail.v2beta.ImportErrorsConfig errors_config = 3;
Returns | |
---|---|
Type | Description |
ImportErrorsConfig |
The errorsConfig. |
getErrorsConfigOrBuilder()
public abstract ImportErrorsConfigOrBuilder getErrorsConfigOrBuilder()
The desired location of errors incurred during the Import.
.google.cloud.retail.v2beta.ImportErrorsConfig errors_config = 3;
Returns | |
---|---|
Type | Description |
ImportErrorsConfigOrBuilder |
getInputConfig()
public abstract ProductInputConfig getInputConfig()
Required. The desired input location of the data.
.google.cloud.retail.v2beta.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ProductInputConfig |
The inputConfig. |
getInputConfigOrBuilder()
public abstract ProductInputConfigOrBuilder getInputConfigOrBuilder()
Required. The desired input location of the data.
.google.cloud.retail.v2beta.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ProductInputConfigOrBuilder |
getNotificationPubsubTopic()
public abstract 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;
Returns | |
---|---|
Type | Description |
String |
The notificationPubsubTopic. |
getNotificationPubsubTopicBytes()
public abstract 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;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for notificationPubsubTopic. |
getParent()
public abstract 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 abstract 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 abstract ImportProductsRequest.ReconciliationMode getReconciliationMode()
The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.
.google.cloud.retail.v2beta.ImportProductsRequest.ReconciliationMode reconciliation_mode = 5;
Returns | |
---|---|
Type | Description |
ImportProductsRequest.ReconciliationMode |
The reconciliationMode. |
getReconciliationModeValue()
public abstract int getReconciliationModeValue()
The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.
.google.cloud.retail.v2beta.ImportProductsRequest.ReconciliationMode reconciliation_mode = 5;
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for reconciliationMode. |
getRequestId() (deprecated)
public abstract String getRequestId()
Deprecated. google.cloud.retail.v2beta.ImportProductsRequest.request_id is deprecated. See google/cloud/retail/v2beta/import_config.proto;l=189
Deprecated. This field has no effect.
string request_id = 6 [deprecated = true];
Returns | |
---|---|
Type | Description |
String |
The requestId. |
getRequestIdBytes() (deprecated)
public abstract ByteString getRequestIdBytes()
Deprecated. google.cloud.retail.v2beta.ImportProductsRequest.request_id is deprecated. See google/cloud/retail/v2beta/import_config.proto;l=189
Deprecated. This field has no effect.
string request_id = 6 [deprecated = true];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for requestId. |
getUpdateMask()
public abstract 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 | |
---|---|
Type | Description |
FieldMask |
The updateMask. |
getUpdateMaskOrBuilder()
public abstract 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;
Returns | |
---|---|
Type | Description |
FieldMaskOrBuilder |
hasErrorsConfig()
public abstract boolean hasErrorsConfig()
The desired location of errors incurred during the Import.
.google.cloud.retail.v2beta.ImportErrorsConfig errors_config = 3;
Returns | |
---|---|
Type | Description |
boolean |
Whether the errorsConfig field is set. |
hasInputConfig()
public abstract boolean hasInputConfig()
Required. The desired input location of the data.
.google.cloud.retail.v2beta.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean |
Whether the inputConfig field is set. |
hasUpdateMask()
public abstract 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 | |
---|---|
Type | Description |
boolean |
Whether the updateMask field is set. |