Package com.google.cloud.retail.v2alpha

Class ListControlsRequest.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<ListControlsRequest.Builder>

      • clear

        public ListControlsRequest.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<ListControlsRequest.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<ListControlsRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public ListControlsRequest.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<ListControlsRequest.Builder>

      • setField

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

      • clearField

        public ListControlsRequest.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<ListControlsRequest.Builder>

      • clearOneof

        public ListControlsRequest.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<ListControlsRequest.Builder>

      • setRepeatedField

        public ListControlsRequest.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<ListControlsRequest.Builder>

      • addRepeatedField

        public ListControlsRequest.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<ListControlsRequest.Builder>

      • mergeFrom

        public ListControlsRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListControlsRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public ListControlsRequest.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<ListControlsRequest.Builder>
        Throws:
        IOException

      • getParent

        public String getParent()
         Required. The catalog resource name. Format:
 `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListControlsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The catalog resource name. Format:
 `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListControlsRequestOrBuilder
        Returns:
        The bytes for parent.

      • setParent

        public ListControlsRequest.Builder setParent​(String value)
         Required. The catalog resource name. Format:
 `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
        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 ListControlsRequest.Builder clearParent()
         Required. The catalog resource name. Format:
 `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setParentBytes

        public ListControlsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Required. The catalog resource name. Format:
 `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
        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.

      • getPageSize

        public int getPageSize()
         Optional. Maximum number of results to return. If unspecified, defaults
 to 50. Max allowed value is 1000.
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageSize in interface ListControlsRequestOrBuilder
        Returns:
        The pageSize.

      • setPageSize

        public ListControlsRequest.Builder setPageSize​(int value)
         Optional. Maximum number of results to return. If unspecified, defaults
 to 50. Max allowed value is 1000.
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public ListControlsRequest.Builder clearPageSize()
         Optional. Maximum number of results to return. If unspecified, defaults
 to 50. Max allowed value is 1000.
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • getPageToken

        public String getPageToken()
         Optional. A page token, received from a previous `ListControls` call.
 Provide this to retrieve the subsequent page.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageToken in interface ListControlsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional. A page token, received from a previous `ListControls` call.
 Provide this to retrieve the subsequent page.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageTokenBytes in interface ListControlsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public ListControlsRequest.Builder setPageToken​(String value)
         Optional. A page token, received from a previous `ListControls` call.
 Provide this to retrieve the subsequent page.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public ListControlsRequest.Builder clearPageToken()
         Optional. A page token, received from a previous `ListControls` call.
 Provide this to retrieve the subsequent page.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public ListControlsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         Optional. A page token, received from a previous `ListControls` call.
 Provide this to retrieve the subsequent page.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • getFilter

        public String getFilter()
         Optional. A filter to apply on the list results. Supported features:

 * List all the products under the parent branch if
 [filter][google.cloud.retail.v2alpha.ListControlsRequest.filter] is unset.
 * List controls that are used in a single ServingConfig:
     'serving_config = "boosted_home_page_cvr"'
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilter in interface ListControlsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Optional. A filter to apply on the list results. Supported features:

 * List all the products under the parent branch if
 [filter][google.cloud.retail.v2alpha.ListControlsRequest.filter] is unset.
 * List controls that are used in a single ServingConfig:
     'serving_config = "boosted_home_page_cvr"'
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterBytes in interface ListControlsRequestOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public ListControlsRequest.Builder setFilter​(String value)
         Optional. A filter to apply on the list results. Supported features:

 * List all the products under the parent branch if
 [filter][google.cloud.retail.v2alpha.ListControlsRequest.filter] is unset.
 * List controls that are used in a single ServingConfig:
     'serving_config = "boosted_home_page_cvr"'
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public ListControlsRequest.Builder clearFilter()
         Optional. A filter to apply on the list results. Supported features:

 * List all the products under the parent branch if
 [filter][google.cloud.retail.v2alpha.ListControlsRequest.filter] is unset.
 * List controls that are used in a single ServingConfig:
     'serving_config = "boosted_home_page_cvr"'
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setFilterBytes

        public ListControlsRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         Optional. A filter to apply on the list results. Supported features:

 * List all the products under the parent branch if
 [filter][google.cloud.retail.v2alpha.ListControlsRequest.filter] is unset.
 * List controls that are used in a single ServingConfig:
     'serving_config = "boosted_home_page_cvr"'
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ListControlsRequest.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<ListControlsRequest.Builder>

      • mergeUnknownFields

        public final ListControlsRequest.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<ListControlsRequest.Builder>