Class ListNamespacesRequest

  • All Implemented Interfaces:
    ListNamespacesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class ListNamespacesRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements ListNamespacesRequestOrBuilder
     The request message for
     [RegistrationService.ListNamespaces][google.cloud.servicedirectory.v1beta1.RegistrationService.ListNamespaces].
     
    Protobuf type google.cloud.servicedirectory.v1beta1.ListNamespacesRequest
    See Also:
    Serialized Form
    • 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. The resource name of the project and location whose namespaces
         you'd like to list.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListNamespacesRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the project and location whose namespaces
         you'd like to list.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListNamespacesRequestOrBuilder
        Returns:
        The bytes for parent.
      • getPageSize

        public int getPageSize()
         Optional. The maximum number of items to return.
         
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageSize in interface ListNamespacesRequestOrBuilder
        Returns:
        The pageSize.
      • getPageToken

        public String getPageToken()
         Optional. The next_page_token value returned from a previous List request,
         if any.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageToken in interface ListNamespacesRequestOrBuilder
        Returns:
        The pageToken.
      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional. The next_page_token value returned from a previous List request,
         if any.
         
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageTokenBytes in interface ListNamespacesRequestOrBuilder
        Returns:
        The bytes for pageToken.
      • getFilter

        public String getFilter()
         Optional. The filter to list results by.
        
         General `filter` string syntax:
         `<field> <operator> <value> (<logical connector>)`
        
         *   `<field>` can be `name`, `labels.<key>` for map field, or
         `attributes.<field>` for attributes field
         *   `<operator>` can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:`
             means `HAS`, and is roughly the same as `=`
         *   `<value>` must be the same data type as field
         *   `<logical connector>` can be `AND`, `OR`, `NOT`
        
         Examples of valid filters:
        
         *   `labels.owner` returns namespaces that have a label with the key
             `owner`, this is the same as `labels:owner`
         *   `labels.owner=sd` returns namespaces that have key/value `owner=sd`
         *   `name>projects/my-project/locations/us-east1/namespaces/namespace-c`
             returns namespaces that have name that is alphabetically later than the
             string, so "namespace-e" is returned but "namespace-a" is not
         *   `labels.owner!=sd AND labels.foo=bar` returns namespaces that have
             `owner` in label key but value is not `sd` AND have key/value `foo=bar`
         *   `doesnotexist.foo=bar` returns an empty list. Note that namespace
             doesn't have a field called "doesnotexist". Since the filter does not
             match any namespaces, it returns no results
         *   `attributes.managed_registration=true` returns namespaces that are
             managed by a GCP product or service
        
         For more information about filtering, see
         [API Filtering](https://aip.dev/160).
         
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilter in interface ListNamespacesRequestOrBuilder
        Returns:
        The filter.
      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Optional. The filter to list results by.
        
         General `filter` string syntax:
         `<field> <operator> <value> (<logical connector>)`
        
         *   `<field>` can be `name`, `labels.<key>` for map field, or
         `attributes.<field>` for attributes field
         *   `<operator>` can be `<`, `>`, `<=`, `>=`, `!=`, `=`, `:`. Of which `:`
             means `HAS`, and is roughly the same as `=`
         *   `<value>` must be the same data type as field
         *   `<logical connector>` can be `AND`, `OR`, `NOT`
        
         Examples of valid filters:
        
         *   `labels.owner` returns namespaces that have a label with the key
             `owner`, this is the same as `labels:owner`
         *   `labels.owner=sd` returns namespaces that have key/value `owner=sd`
         *   `name>projects/my-project/locations/us-east1/namespaces/namespace-c`
             returns namespaces that have name that is alphabetically later than the
             string, so "namespace-e" is returned but "namespace-a" is not
         *   `labels.owner!=sd AND labels.foo=bar` returns namespaces that have
             `owner` in label key but value is not `sd` AND have key/value `foo=bar`
         *   `doesnotexist.foo=bar` returns an empty list. Note that namespace
             doesn't have a field called "doesnotexist". Since the filter does not
             match any namespaces, it returns no results
         *   `attributes.managed_registration=true` returns namespaces that are
             managed by a GCP product or service
        
         For more information about filtering, see
         [API Filtering](https://aip.dev/160).
         
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterBytes in interface ListNamespacesRequestOrBuilder
        Returns:
        The bytes for filter.
      • getOrderBy

        public String getOrderBy()
         Optional. The order to list results by.
        
         General `order_by` string syntax: `<field> (<asc|desc>) (,)`
        
         *   `<field>` allows value: `name`
         *   `<asc|desc>` ascending or descending order by `<field>`. If this is
             left blank, `asc` is used
        
         Note that an empty `order_by` string results in default order, which is
         order by `name` in ascending order.
         
        string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOrderBy in interface ListNamespacesRequestOrBuilder
        Returns:
        The orderBy.
      • getOrderByBytes

        public com.google.protobuf.ByteString getOrderByBytes()
         Optional. The order to list results by.
        
         General `order_by` string syntax: `<field> (<asc|desc>) (,)`
        
         *   `<field>` allows value: `name`
         *   `<asc|desc>` ascending or descending order by `<field>`. If this is
             left blank, `asc` is used
        
         Note that an empty `order_by` string results in default order, which is
         order by `name` in ascending order.
         
        string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOrderByBytes in interface ListNamespacesRequestOrBuilder
        Returns:
        The bytes for orderBy.
      • 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 ListNamespacesRequest parseFrom​(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

        public com.google.protobuf.Parser<ListNamespacesRequest> 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 ListNamespacesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder