Package com.google.cloud.retail.v2alpha

Class ImportProductsRequest

  • All Implemented Interfaces:
    ImportProductsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ImportProductsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ImportProductsRequestOrBuilder
     Request message for Import methods.
    Protobuf type google.cloud.retail.v2alpha.ImportProductsRequest
    See Also:
    Serialized Form

    • Field Detail

      • REQUEST_ID_FIELD_NUMBER

        public static final int REQUEST_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INPUT_CONFIG_FIELD_NUMBER

        public static final int INPUT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ERRORS_CONFIG_FIELD_NUMBER

        public static final int ERRORS_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_MASK_FIELD_NUMBER

        public static final int UPDATE_MASK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RECONCILIATION_MODE_FIELD_NUMBER

        public static final int RECONCILIATION_MODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER

        public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SKIP_DEFAULT_BRANCH_PROTECTION_FIELD_NUMBER

        public static final int SKIP_DEFAULT_BRANCH_PROTECTION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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) = { ... }
        Specified by:
        getParent in interface ImportProductsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface ImportProductsRequestOrBuilder
        Returns:
        The bytes for parent.

      • 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];
        Specified by:
        getRequestId in interface ImportProductsRequestOrBuilder
        Returns:
        The requestId.

      • getRequestIdBytes

        @Deprecated
public 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];
        Specified by:
        getRequestIdBytes in interface ImportProductsRequestOrBuilder
        Returns:
        The bytes for requestId.

      • 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];
        Specified by:
        hasInputConfig in interface ImportProductsRequestOrBuilder
        Returns:
        Whether the inputConfig field is set.

      • 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];
        Specified by:
        getInputConfig in interface ImportProductsRequestOrBuilder
        Returns:
        The inputConfig.

      • hasErrorsConfig

        public boolean hasErrorsConfig()
         The desired location of errors incurred during the Import.
        .google.cloud.retail.v2alpha.ImportErrorsConfig errors_config = 3;
        Specified by:
        hasErrorsConfig in interface ImportProductsRequestOrBuilder
        Returns:
        Whether the errorsConfig 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;
        Specified by:
        hasUpdateMask in interface ImportProductsRequestOrBuilder
        Returns:
        Whether the updateMask field is set.

      • getUpdateMask

        public 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;
        Specified by:
        getUpdateMask in interface ImportProductsRequestOrBuilder
        Returns:
        The updateMask.

      • getUpdateMaskOrBuilder

        public 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;
        Specified by:
        getUpdateMaskOrBuilder in interface ImportProductsRequestOrBuilder

      • 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.INCREMENTAL].
        .google.cloud.retail.v2alpha.ImportProductsRequest.ReconciliationMode reconciliation_mode = 5;
        Specified by:
        getReconciliationModeValue in interface ImportProductsRequestOrBuilder
        Returns:
        The enum numeric value on the wire for reconciliationMode.

      • 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.INCREMENTAL].
        .google.cloud.retail.v2alpha.ImportProductsRequest.ReconciliationMode reconciliation_mode = 5;
        Specified by:
        getReconciliationMode in interface ImportProductsRequestOrBuilder
        Returns:
        The reconciliationMode.

      • 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][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;
        Specified by:
        getNotificationPubsubTopic in interface ImportProductsRequestOrBuilder
        Returns:
        The notificationPubsubTopic.

      • getNotificationPubsubTopicBytes

        public 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;
        Specified by:
        getNotificationPubsubTopicBytes in interface ImportProductsRequestOrBuilder
        Returns:
        The bytes for notificationPubsubTopic.

      • 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][google.cloud.retail.v2alpha.ImportProductsRequest.reconciliation_mode]
 is set to `FULL`.
        bool skip_default_branch_protection = 8;
        Specified by:
        getSkipDefaultBranchProtection in interface ImportProductsRequestOrBuilder
        Returns:
        The skipDefaultBranchProtection.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ImportProductsRequest parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImportProductsRequest parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImportProductsRequest parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImportProductsRequest parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImportProductsRequest parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImportProductsRequest parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public ImportProductsRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ImportProductsRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ImportProductsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ImportProductsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ImportProductsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder