Class ImportProductsRequest (2.45.0) 

public final class ImportProductsRequest extends GeneratedMessageV3 implements ImportProductsRequestOrBuilder

Request message for Import methods.

Protobuf type google.cloud.retail.v2alpha.ImportProductsRequest

Inheritance

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

Static Fields

ERRORS_CONFIG_FIELD_NUMBER

public static final int ERRORS_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER

public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

RECONCILIATION_MODE_FIELD_NUMBER

public static final int RECONCILIATION_MODE_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

SKIP_DEFAULT_BRANCH_PROTECTION_FIELD_NUMBER

public static final int SKIP_DEFAULT_BRANCH_PROTECTION_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ImportProductsRequest getDefaultInstance()
Returns
Type Description
ImportProductsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ImportProductsRequest.Builder newBuilder()
Returns
Type Description
ImportProductsRequest.Builder

newBuilder(ImportProductsRequest prototype)

public static ImportProductsRequest.Builder newBuilder(ImportProductsRequest prototype)
Parameter
Name Description
prototype ImportProductsRequest
Returns
Type Description
ImportProductsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ImportProductsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ImportProductsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportProductsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportProductsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ImportProductsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ImportProductsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ImportProductsRequest> parser()
Returns
Type Description
Parser<ImportProductsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ImportProductsRequest getDefaultInstanceForType()
Returns
Type Description
ImportProductsRequest

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.

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.

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

getParserForType()

public Parser<ImportProductsRequest> getParserForType()
Returns
Type Description
Parser<ImportProductsRequest>
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;

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=189

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=189

Deprecated. This field has no effect.

string request_id = 6 [deprecated = true];

Returns
Type Description
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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;

Returns
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;

Returns
Type Description
FieldMask

The updateMask.

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;

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, all fields are updated.

.google.protobuf.FieldMask update_mask = 4;

Returns
Type Description
boolean

Whether the updateMask field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ImportProductsRequest.Builder newBuilderForType()
Returns
Type Description
ImportProductsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImportProductsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ImportProductsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ImportProductsRequest.Builder toBuilder()
Returns
Type Description
ImportProductsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException