Class ImportProductsRequest (2.2.3)

public final class ImportProductsRequest extends GeneratedMessageV3 implements ImportProductsRequestOrBuilder

Request message for Import methods.

Protobuf type google.cloud.retail.v2.ImportProductsRequest

Static Fields

ERRORS_CONFIG_FIELD_NUMBER

public static final int ERRORS_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER

public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

RECONCILIATION_MODE_FIELD_NUMBER

public static final int RECONCILIATION_MODE_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ImportProductsRequest getDefaultInstance()
Returns
TypeDescription
ImportProductsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ImportProductsRequest.Builder newBuilder()
Returns
TypeDescription
ImportProductsRequest.Builder

newBuilder(ImportProductsRequest prototype)

public static ImportProductsRequest.Builder newBuilder(ImportProductsRequest prototype)
Parameter
NameDescription
prototypeImportProductsRequest
Returns
TypeDescription
ImportProductsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ImportProductsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ImportProductsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportProductsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportProductsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ImportProductsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ImportProductsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportProductsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportProductsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ImportProductsRequest> parser()
Returns
TypeDescription
Parser<ImportProductsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ImportProductsRequest getDefaultInstanceForType()
Returns
TypeDescription
ImportProductsRequest

getErrorsConfig()

public ImportErrorsConfig getErrorsConfig()

The desired location of errors incurred during the Import.

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

Returns
TypeDescription
ImportErrorsConfig

The errorsConfig.

getErrorsConfigOrBuilder()

public ImportErrorsConfigOrBuilder getErrorsConfigOrBuilder()

The desired location of errors incurred during the Import.

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

Returns
TypeDescription
ImportErrorsConfigOrBuilder

getInputConfig()

public ProductInputConfig getInputConfig()

Required. The desired input location of the data.

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

Returns
TypeDescription
ProductInputConfig

The inputConfig.

getInputConfigOrBuilder()

public ProductInputConfigOrBuilder getInputConfigOrBuilder()

Required. The desired input location of the data.

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

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

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<ImportProductsRequest> getParserForType()
Returns
TypeDescription
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.v2.ImportProductsRequest.ReconciliationMode reconciliation_mode = 5;

Returns
TypeDescription
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.v2.ImportProductsRequest.ReconciliationMode reconciliation_mode = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for reconciliationMode.

getRequestId() (deprecated)

public String getRequestId()

Deprecated. google.cloud.retail.v2.ImportProductsRequest.request_id is deprecated. See google/cloud/retail/v2/import_config.proto;l=199

Deprecated. This field has no effect.

string request_id = 6 [deprecated = true];

Returns
TypeDescription
String

The requestId.

getRequestIdBytes() (deprecated)

public ByteString getRequestIdBytes()

Deprecated. google.cloud.retail.v2.ImportProductsRequest.request_id is deprecated. See google/cloud/retail/v2/import_config.proto;l=199

Deprecated. This field has no effect.

string request_id = 6 [deprecated = true];

Returns
TypeDescription
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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;

Returns
TypeDescription
FieldMask

The updateMask.

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;

Returns
TypeDescription
FieldMaskOrBuilder

hasErrorsConfig()

public boolean hasErrorsConfig()

The desired location of errors incurred during the Import.

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

Returns
TypeDescription
boolean

Whether the errorsConfig field is set.

hasInputConfig()

public boolean hasInputConfig()

Required. The desired input location of the data.

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

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

Returns
TypeDescription
boolean

Whether the updateMask field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ImportProductsRequest.Builder newBuilderForType()
Returns
TypeDescription
ImportProductsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImportProductsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ImportProductsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ImportProductsRequest.Builder toBuilder()
Returns
TypeDescription
ImportProductsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException