Package com.google.cloud.retail.v2alpha

Class ImportProductsRequest.Builder

    • Method Detail

      • 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.Builder<ImportProductsRequest.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ImportProductsRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • clearField

        public ImportProductsRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ImportProductsRequest.Builder>

      • clearOneof

        public ImportProductsRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ImportProductsRequest.Builder>

      • setRepeatedField

        public ImportProductsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ImportProductsRequest.Builder>

      • addRepeatedField

        public ImportProductsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ImportProductsRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public ImportProductsRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ImportProductsRequest.Builder>
        Throws:
        IOException

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

      • setParent

        public ImportProductsRequest.Builder setParent​(String value)
         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) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public ImportProductsRequest.Builder clearParent()
         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:
        This builder for chaining.

      • setParentBytes

        public ImportProductsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

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

      • setRequestId

        @Deprecated
public ImportProductsRequest.Builder setRequestId​(String value)
        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];
        Parameters:
        value - The requestId to set.
        Returns:
        This builder for chaining.

      • clearRequestId

        @Deprecated
public ImportProductsRequest.Builder clearRequestId()
        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:
        This builder for chaining.

      • setRequestIdBytes

        @Deprecated
public ImportProductsRequest.Builder setRequestIdBytes​(com.google.protobuf.ByteString value)
        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];
        Parameters:
        value - The bytes for requestId to set.
        Returns:
        This builder for chaining.

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

      • setInputConfig

        public ImportProductsRequest.Builder setInputConfig​(ProductInputConfig value)
         Required. The desired input location of the data.
        .google.cloud.retail.v2alpha.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];

      • setInputConfig

        public ImportProductsRequest.Builder setInputConfig​(ProductInputConfig.Builder builderForValue)
         Required. The desired input location of the data.
        .google.cloud.retail.v2alpha.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];

      • mergeInputConfig

        public ImportProductsRequest.Builder mergeInputConfig​(ProductInputConfig value)
         Required. The desired input location of the data.
        .google.cloud.retail.v2alpha.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];

      • clearInputConfig

        public ImportProductsRequest.Builder clearInputConfig()
         Required. The desired input location of the data.
        .google.cloud.retail.v2alpha.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];

      • getInputConfigBuilder

        public ProductInputConfig.Builder getInputConfigBuilder()
         Required. The desired input location of the data.
        .google.cloud.retail.v2alpha.ProductInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];

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

      • clearErrorsConfig

        public ImportProductsRequest.Builder clearErrorsConfig()
         The desired location of errors incurred during the Import.
        .google.cloud.retail.v2alpha.ImportErrorsConfig errors_config = 3;

      • getErrorsConfigBuilder

        public ImportErrorsConfig.Builder getErrorsConfigBuilder()
         The desired location of errors incurred during the Import.
        .google.cloud.retail.v2alpha.ImportErrorsConfig errors_config = 3;

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

      • setUpdateMask

        public ImportProductsRequest.Builder setUpdateMask​(com.google.protobuf.FieldMask value)
         Indicates which fields in the provided imported `products` to update. If
 not set, all fields are updated.
        .google.protobuf.FieldMask update_mask = 4;

      • setUpdateMask

        public ImportProductsRequest.Builder setUpdateMask​(com.google.protobuf.FieldMask.Builder builderForValue)
         Indicates which fields in the provided imported `products` to update. If
 not set, all fields are updated.
        .google.protobuf.FieldMask update_mask = 4;

      • mergeUpdateMask

        public ImportProductsRequest.Builder mergeUpdateMask​(com.google.protobuf.FieldMask value)
         Indicates which fields in the provided imported `products` to update. If
 not set, all fields are updated.
        .google.protobuf.FieldMask update_mask = 4;

      • clearUpdateMask

        public ImportProductsRequest.Builder clearUpdateMask()
         Indicates which fields in the provided imported `products` to update. If
 not set, all fields are updated.
        .google.protobuf.FieldMask update_mask = 4;

      • getUpdateMaskBuilder

        public com.google.protobuf.FieldMask.Builder getUpdateMaskBuilder()
         Indicates which fields in the provided imported `products` to update. If
 not set, all fields are updated.
        .google.protobuf.FieldMask update_mask = 4;

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

      • setReconciliationModeValue

        public ImportProductsRequest.Builder setReconciliationModeValue​(int value)
         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;
        Parameters:
        value - The enum numeric value on the wire for reconciliationMode to set.
        Returns:
        This builder for chaining.

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

      • setReconciliationMode

        public ImportProductsRequest.Builder setReconciliationMode​(ImportProductsRequest.ReconciliationMode value)
         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;
        Parameters:
        value - The reconciliationMode to set.
        Returns:
        This builder for chaining.

      • clearReconciliationMode

        public ImportProductsRequest.Builder clearReconciliationMode()
         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;
        Returns:
        This builder for chaining.

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

      • setNotificationPubsubTopic

        public ImportProductsRequest.Builder setNotificationPubsubTopic​(String value)
         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;
        Parameters:
        value - The notificationPubsubTopic to set.
        Returns:
        This builder for chaining.

      • clearNotificationPubsubTopic

        public ImportProductsRequest.Builder clearNotificationPubsubTopic()
         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;
        Returns:
        This builder for chaining.

      • setNotificationPubsubTopicBytes

        public ImportProductsRequest.Builder setNotificationPubsubTopicBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for notificationPubsubTopic to set.
        Returns:
        This builder for chaining.

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

      • setSkipDefaultBranchProtection

        public ImportProductsRequest.Builder setSkipDefaultBranchProtection​(boolean value)
         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;
        Parameters:
        value - The skipDefaultBranchProtection to set.
        Returns:
        This builder for chaining.

      • clearSkipDefaultBranchProtection

        public ImportProductsRequest.Builder clearSkipDefaultBranchProtection()
         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;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ImportProductsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ImportProductsRequest.Builder>

      • mergeUnknownFields

        public final ImportProductsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ImportProductsRequest.Builder>