Class ListGlossaryCategoriesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.ListGlossaryCategoriesRequest
All Implemented Interfaces:
ListGlossaryCategoriesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ListGlossaryCategoriesRequest extends com.google.protobuf.GeneratedMessage implements ListGlossaryCategoriesRequestOrBuilder
 List GlossaryCategories Request
 
Protobuf type google.cloud.dataplex.v1.ListGlossaryCategoriesRequest
See Also:
  • Field Details

  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getParent

      public String getParent()
       Required. The parent, which has this collection of GlossaryCategories.
       Format:
       projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
       Location is the Google Cloud region.
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListGlossaryCategoriesRequestOrBuilder
      Returns:
      The parent.
    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The parent, which has this collection of GlossaryCategories.
       Format:
       projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
       Location is the Google Cloud region.
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListGlossaryCategoriesRequestOrBuilder
      Returns:
      The bytes for parent.
    • getPageSize

      public int getPageSize()
       Optional. The maximum number of GlossaryCategories to return. The service
       may return fewer than this value. If unspecified, at most 50
       GlossaryCategories will be returned. The maximum value is 1000; values
       above 1000 will be coerced to 1000.
       
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface ListGlossaryCategoriesRequestOrBuilder
      Returns:
      The pageSize.
    • getPageToken

      public String getPageToken()
       Optional. A page token, received from a previous `ListGlossaryCategories`
       call. Provide this to retrieve the subsequent page. When paginating, all
       other parameters provided to `ListGlossaryCategories` must match the call
       that provided the page token.
       
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface ListGlossaryCategoriesRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. A page token, received from a previous `ListGlossaryCategories`
       call. Provide this to retrieve the subsequent page. When paginating, all
       other parameters provided to `ListGlossaryCategories` must match the call
       that provided the page token.
       
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface ListGlossaryCategoriesRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • getFilter

      public String getFilter()
       Optional. Filter expression that filters GlossaryCategories listed in the
       response. Filters are supported on the following fields:
       - immediate_parent
      
       Examples of using a filter are:
       -
       `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}"`
       -
       `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"`
      
       This will only return the GlossaryCategories that are directly nested
       under the specified parent.
       
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilter in interface ListGlossaryCategoriesRequestOrBuilder
      Returns:
      The filter.
    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Optional. Filter expression that filters GlossaryCategories listed in the
       response. Filters are supported on the following fields:
       - immediate_parent
      
       Examples of using a filter are:
       -
       `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}"`
       -
       `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"`
      
       This will only return the GlossaryCategories that are directly nested
       under the specified parent.
       
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterBytes in interface ListGlossaryCategoriesRequestOrBuilder
      Returns:
      The bytes for filter.
    • getOrderBy

      public String getOrderBy()
       Optional. Order by expression that orders GlossaryCategories listed in the
       response. Order by fields are: `name` or `create_time` for the result. If
       not specified, the ordering is undefined.
       
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOrderBy in interface ListGlossaryCategoriesRequestOrBuilder
      Returns:
      The orderBy.
    • getOrderByBytes

      public com.google.protobuf.ByteString getOrderByBytes()
       Optional. Order by expression that orders GlossaryCategories listed in the
       response. Order by fields are: `name` or `create_time` for the result. If
       not specified, the ordering is undefined.
       
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOrderByBytes in interface ListGlossaryCategoriesRequestOrBuilder
      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.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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 ListGlossaryCategoriesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static ListGlossaryCategoriesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ListGlossaryCategoriesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ListGlossaryCategoriesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ListGlossaryCategoriesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ListGlossaryCategoriesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ListGlossaryCategoriesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

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

      public static ListGlossaryCategoriesRequest.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected ListGlossaryCategoriesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static ListGlossaryCategoriesRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ListGlossaryCategoriesRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<ListGlossaryCategoriesRequest> 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.GeneratedMessage
    • getDefaultInstanceForType

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