- 1.51.0 (latest)
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.2
- 1.0.1
- 0.2.2
public static final class ListEntitiesRequest.Builder extends GeneratedMessageV3.Builder<ListEntitiesRequest.Builder> implements ListEntitiesRequestOrBuilderList metadata entities request.
Protobuf type google.cloud.dataplex.v1.ListEntitiesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListEntitiesRequest.BuilderImplements
ListEntitiesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListEntitiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
build()
public ListEntitiesRequest build()| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest |
|
buildPartial()
public ListEntitiesRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest |
|
clear()
public ListEntitiesRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListEntitiesRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
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 | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListEntitiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
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 | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
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 | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
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 | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
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 | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
This builder for chaining. |
clone()
public ListEntitiesRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
getDefaultInstanceForType()
public ListEntitiesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
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];
| Returns | |
|---|---|
| Type | Description |
int |
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];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
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];
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.EntityView |
The view. |
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];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for view. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListEntitiesRequest other)
public ListEntitiesRequest.Builder mergeFrom(ListEntitiesRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListEntitiesRequest |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListEntitiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListEntitiesRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListEntitiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListEntitiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
setFilter(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListEntitiesRequest.Builder setFilterBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
This builder for chaining. |
setPageSize(int value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
This builder for chaining. |
setPageToken(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListEntitiesRequest.Builder setPageTokenBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
This builder for chaining. |
setParent(String value)
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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListEntitiesRequest.Builder setParentBytes(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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListEntitiesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListEntitiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
|
setView(ListEntitiesRequest.EntityView value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
ListEntitiesRequest.EntityViewThe view to set. |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
This builder for chaining. |
setViewValue(int value)
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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for view to set. |
| Returns | |
|---|---|
| Type | Description |
ListEntitiesRequest.Builder |
This builder for chaining. |