Package com.google.cloud.dataplex.v1

Interface ListEntitiesRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    ListEntitiesRequest.EntityView
    getView()
    Required.
    int
    getViewValue()
    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 resource name of the parent zone:
 `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The resource name of the parent zone:
 `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getViewValue

      int getViewValue()
       Required. Specify the entity view to make a partial list request.
      .google.cloud.dataplex.v1.ListEntitiesRequest.EntityView view = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for view.

    • getView

      ListEntitiesRequest.EntityView getView()
       Required. Specify the entity view to make a partial list request.
      .google.cloud.dataplex.v1.ListEntitiesRequest.EntityView view = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The view.

    • getPageSize

      int getPageSize()
       Optional. Maximum number of entities to return. The service may return
 fewer than this value. If unspecified, 100 entities will be returned by
 default. The maximum value is 500; larger values will will be truncated to
 500.
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional. Page token received from a previous `ListEntities` call. Provide
 this to retrieve the subsequent page. When paginating, all other parameters
 provided to `ListEntities` must match the call that provided the
 page token.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. Page token received from a previous `ListEntities` call. Provide
 this to retrieve the subsequent page. When paginating, all other parameters
 provided to `ListEntities` must match the call that provided the
 page token.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • getFilter

      String getFilter()
       Optional. The following filter parameters can be added to the URL to limit
 the entities returned by the API:

 - Entity ID: ?filter="id=entityID"
 - Asset ID: ?filter="asset=assetID"
 - Data path ?filter="data_path=gs://my-bucket"
 - Is HIVE compatible: ?filter="hive_compatible=true"
 - Is BigQuery compatible: ?filter="bigquery_compatible=true"
      string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. The following filter parameters can be added to the URL to limit
 the entities returned by the API:

 - Entity ID: ?filter="id=entityID"
 - Asset ID: ?filter="asset=assetID"
 - Data path ?filter="data_path=gs://my-bucket"
 - Is HIVE compatible: ?filter="hive_compatible=true"
 - Is BigQuery compatible: ?filter="bigquery_compatible=true"
      string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.