Package com.google.cloud.dataplex.v1

Class ListEntitiesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListEntitiesRequest.Builder>
com.google.cloud.dataplex.v1.ListEntitiesRequest.Builder
All Implemented Interfaces:
ListEntitiesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListEntitiesRequest
public static final class ListEntitiesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListEntitiesRequest.Builder> implements ListEntitiesRequestOrBuilder
 List metadata entities request.
Protobuf type google.cloud.dataplex.v1.ListEntitiesRequest

  • 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.Builder<ListEntitiesRequest.Builder>

    • clear

      public ListEntitiesRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListEntitiesRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListEntitiesRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ListEntitiesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListEntitiesRequest.Builder>

    • mergeFrom

      public ListEntitiesRequest.Builder mergeFrom(ListEntitiesRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListEntitiesRequest.Builder>

    • mergeFrom

      public ListEntitiesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListEntitiesRequest.Builder>
      Throws:
      IOException

    • 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.

    • setParent

      public ListEntitiesRequest.Builder setParent(String value)
       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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ListEntitiesRequest.Builder clearParent()
       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:
      This builder for chaining.

    • setParentBytes

      public ListEntitiesRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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.

    • setViewValue

      public ListEntitiesRequest.Builder setViewValue(int value)
       Required. Specify the entity view to make a partial list request.
      .google.cloud.dataplex.v1.ListEntitiesRequest.EntityView view = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for view to set.
      Returns:
      This builder for chaining.

    • 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.

    • setView

      public ListEntitiesRequest.Builder setView(ListEntitiesRequest.EntityView value)
       Required. Specify the entity view to make a partial list request.
      .google.cloud.dataplex.v1.ListEntitiesRequest.EntityView view = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The view to set.
      Returns:
      This builder for chaining.

    • clearView

      public ListEntitiesRequest.Builder clearView()
       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:
      This builder for chaining.

    • 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.

    • setPageSize

      public ListEntitiesRequest.Builder setPageSize(int value)
       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];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListEntitiesRequest.Builder clearPageSize()
       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:
      This builder for chaining.

    • 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.

    • setPageToken

      public ListEntitiesRequest.Builder setPageToken(String value)
       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];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListEntitiesRequest.Builder clearPageToken()
       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:
      This builder for chaining.

    • setPageTokenBytes

      public ListEntitiesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • 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.

    • setFilter

      public ListEntitiesRequest.Builder setFilter(String value)
       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];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ListEntitiesRequest.Builder clearFilter()
       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:
      This builder for chaining.

    • setFilterBytes

      public ListEntitiesRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.