Class ListInstancesRequest.Builder

  • All Implemented Interfaces:
    ListInstancesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ListInstancesRequest

    public static final class ListInstancesRequest.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<ListInstancesRequest.Builder>
    implements ListInstancesRequestOrBuilder
     Request for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].
     
    Protobuf type google.cloud.redis.v1.ListInstancesRequest
    • 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<ListInstancesRequest.Builder>
      • clear

        public ListInstancesRequest.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<ListInstancesRequest.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<ListInstancesRequest.Builder>
      • getDefaultInstanceForType

        public ListInstancesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

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

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

        public ListInstancesRequest.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<ListInstancesRequest.Builder>
      • setField

        public ListInstancesRequest.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<ListInstancesRequest.Builder>
      • clearField

        public ListInstancesRequest.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<ListInstancesRequest.Builder>
      • clearOneof

        public ListInstancesRequest.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<ListInstancesRequest.Builder>
      • setRepeatedField

        public ListInstancesRequest.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<ListInstancesRequest.Builder>
      • addRepeatedField

        public ListInstancesRequest.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<ListInstancesRequest.Builder>
      • isInitialized

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

        public ListInstancesRequest.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<ListInstancesRequest.Builder>
        Throws:
        IOException
      • getParent

        public String getParent()
         Required. The resource name of the instance location using the form:
             `projects/{project_id}/locations/{location_id}`
         where `location_id` refers to a GCP region.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListInstancesRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the instance location using the form:
             `projects/{project_id}/locations/{location_id}`
         where `location_id` refers to a GCP region.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListInstancesRequestOrBuilder
        Returns:
        The bytes for parent.
      • setParent

        public ListInstancesRequest.Builder setParent​(String value)
         Required. The resource name of the instance location using the form:
             `projects/{project_id}/locations/{location_id}`
         where `location_id` refers to a GCP region.
         
        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 ListInstancesRequest.Builder clearParent()
         Required. The resource name of the instance location using the form:
             `projects/{project_id}/locations/{location_id}`
         where `location_id` refers to a GCP region.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.
      • setParentBytes

        public ListInstancesRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Required. The resource name of the instance location using the form:
             `projects/{project_id}/locations/{location_id}`
         where `location_id` refers to a GCP region.
         
        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()
         The maximum number of items to return.
        
         If not specified, a default value of 1000 will be used by the service.
         Regardless of the page_size value, the response may include a partial list
         and a caller should only rely on response's
         [`next_page_token`][google.cloud.redis.v1.ListInstancesResponse.next_page_token]
         to determine if there are more instances left to be queried.
         
        int32 page_size = 2;
        Specified by:
        getPageSize in interface ListInstancesRequestOrBuilder
        Returns:
        The pageSize.
      • setPageSize

        public ListInstancesRequest.Builder setPageSize​(int value)
         The maximum number of items to return.
        
         If not specified, a default value of 1000 will be used by the service.
         Regardless of the page_size value, the response may include a partial list
         and a caller should only rely on response's
         [`next_page_token`][google.cloud.redis.v1.ListInstancesResponse.next_page_token]
         to determine if there are more instances left to be queried.
         
        int32 page_size = 2;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.
      • clearPageSize

        public ListInstancesRequest.Builder clearPageSize()
         The maximum number of items to return.
        
         If not specified, a default value of 1000 will be used by the service.
         Regardless of the page_size value, the response may include a partial list
         and a caller should only rely on response's
         [`next_page_token`][google.cloud.redis.v1.ListInstancesResponse.next_page_token]
         to determine if there are more instances left to be queried.
         
        int32 page_size = 2;
        Returns:
        This builder for chaining.
      • getPageToken

        public String getPageToken()
         The `next_page_token` value returned from a previous
         [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances] request, if
         any.
         
        string page_token = 3;
        Specified by:
        getPageToken in interface ListInstancesRequestOrBuilder
        Returns:
        The pageToken.
      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         The `next_page_token` value returned from a previous
         [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances] request, if
         any.
         
        string page_token = 3;
        Specified by:
        getPageTokenBytes in interface ListInstancesRequestOrBuilder
        Returns:
        The bytes for pageToken.
      • setPageToken

        public ListInstancesRequest.Builder setPageToken​(String value)
         The `next_page_token` value returned from a previous
         [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances] request, if
         any.
         
        string page_token = 3;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.
      • clearPageToken

        public ListInstancesRequest.Builder clearPageToken()
         The `next_page_token` value returned from a previous
         [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances] request, if
         any.
         
        string page_token = 3;
        Returns:
        This builder for chaining.
      • setPageTokenBytes

        public ListInstancesRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         The `next_page_token` value returned from a previous
         [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances] request, if
         any.
         
        string page_token = 3;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final ListInstancesRequest.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<ListInstancesRequest.Builder>
      • mergeUnknownFields

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