Package com.google.cloud.dataplex.v1

Class ListEntitiesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.ListEntitiesRequest
All Implemented Interfaces:
ListEntitiesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ListEntitiesRequest extends com.google.protobuf.GeneratedMessage implements ListEntitiesRequestOrBuilder
 List metadata entities request.
Protobuf type google.cloud.dataplex.v1.ListEntitiesRequest
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 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) = { ... }
      Specified by:
      getParent in interface ListEntitiesRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListEntitiesRequestOrBuilder
      Returns:
      The bytes for parent.

    • getViewValue

      public 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];
      Specified by:
      getViewValue in interface ListEntitiesRequestOrBuilder
      Returns:
      The enum numeric value on the wire for view.

    • getView

      public 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];
      Specified by:
      getView in interface ListEntitiesRequestOrBuilder
      Returns:
      The view.

    • getPageSize

      public 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];
      Specified by:
      getPageSize in interface ListEntitiesRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public 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];
      Specified by:
      getPageToken in interface ListEntitiesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public 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];
      Specified by:
      getPageTokenBytes in interface ListEntitiesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getFilter

      public 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];
      Specified by:
      getFilter in interface ListEntitiesRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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];
      Specified by:
      getFilterBytes in interface ListEntitiesRequestOrBuilder
      Returns:
      The bytes for filter.

    • 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 ListEntitiesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ListEntitiesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ListEntitiesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ListEntitiesRequest.Builder newBuilder()

    • newBuilder

      public static ListEntitiesRequest.Builder newBuilder(ListEntitiesRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ListEntitiesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListEntitiesRequest> parser()

    • getParserForType

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