Package com.google.cloud.dataplex.v1

Interface ListGlossaryCategoriesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListGlossaryCategoriesRequest, ListGlossaryCategoriesRequest.Builder
@Generated public interface ListGlossaryCategoriesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    String
    getOrderBy()
    Optional.
    com.google.protobuf.ByteString
    getOrderByBytes()
    Optional.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      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) = { ... }
      Returns:
      The parent.

    • getParentBytes

      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) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      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];
      Returns:
      The pageSize.

    • getPageToken

      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];
      Returns:
      The pageToken.

    • getPageTokenBytes

      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];
      Returns:
      The bytes for pageToken.

    • getFilter

      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];
      Returns:
      The filter.

    • getFilterBytes

      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];
      Returns:
      The bytes for filter.

    • getOrderBy

      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];
      Returns:
      The orderBy.

    • getOrderByBytes

      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];
      Returns:
      The bytes for orderBy.