public final class ImportProductsRequest extends GeneratedMessageV3 implements ImportProductsRequestOrBuilder
Request message for Import methods.
Protobuf type google.cloud.retail.v2alpha.ImportProductsRequest
Static Fields
ERRORS_CONFIG_FIELD_NUMBER
public static final int ERRORS_CONFIG_FIELD_NUMBER
Field Value
public static final int INPUT_CONFIG_FIELD_NUMBER
Field Value
NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
RECONCILIATION_MODE_FIELD_NUMBER
public static final int RECONCILIATION_MODE_FIELD_NUMBER
Field Value
REQUEST_ID_FIELD_NUMBER
public static final int REQUEST_ID_FIELD_NUMBER
Field Value
SKIP_DEFAULT_BRANCH_PROTECTION_FIELD_NUMBER
public static final int SKIP_DEFAULT_BRANCH_PROTECTION_FIELD_NUMBER
Field Value
UPDATE_MASK_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ImportProductsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ImportProductsRequest.Builder newBuilder()
Returns
newBuilder(ImportProductsRequest prototype)
public static ImportProductsRequest.Builder newBuilder(ImportProductsRequest prototype)
Parameter
Returns
public static ImportProductsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ImportProductsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ImportProductsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ImportProductsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ImportProductsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ImportProductsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ImportProductsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ImportProductsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ImportProductsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ImportProductsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ImportProductsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ImportProductsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ImportProductsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ImportProductsRequest getDefaultInstanceForType()
Returns
getErrorsConfig()
public ImportErrorsConfig getErrorsConfig()
The desired location of errors incurred during the Import.
.google.cloud.retail.v2alpha.ImportErrorsConfig errors_config = 3;
getErrorsConfigOrBuilder()
public ImportErrorsConfigOrBuilder getErrorsConfigOrBuilder()
The desired location of errors incurred during the Import.
.google.cloud.retail.v2alpha.ImportErrorsConfig errors_config = 3;
public ProductInputConfig getInputConfig()
Required. The desired input location of the data.
.google.cloud.retail.v2alpha.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];
public ProductInputConfigOrBuilder getInputConfigOrBuilder()
Required. The desired input location of the data.
.google.cloud.retail.v2alpha.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];
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
cloud-retail-customer-data-access@system.gserviceaccount.com 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;
| 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
cloud-retail-customer-data-access@system.gserviceaccount.com 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;
| 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) = { ... }
getParserForType()
public Parser<ImportProductsRequest> getParserForType()
Returns
Overrides
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;
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=202
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=202
Deprecated. This field has no effect.
string request_id = 6 [deprecated = true];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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;
| Type | Description |
| boolean | The skipDefaultBranchProtection.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
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;
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.
|
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, will by default update all fields.
.google.protobuf.FieldMask update_mask = 4;
| Type | Description |
| boolean | Whether the updateMask field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ImportProductsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ImportProductsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ImportProductsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
