public static final class ListDataProductsRequest.Builder extends GeneratedMessage.Builder<ListDataProductsRequest.Builder> implements ListDataProductsRequestOrBuilderRequest message for listing data products.
Protobuf type google.cloud.dataplex.v1.ListDataProductsRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListDataProductsRequest.BuilderImplements
ListDataProductsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public ListDataProductsRequest build()| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest |
|
buildPartial()
public ListDataProductsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest |
|
clear()
public ListDataProductsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
|
clearFilter()
public ListDataProductsRequest.Builder clearFilter()Optional. Filter expression that filters data products listed in the response.
Example of using this filter is: display_name="my-data-product"
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
This builder for chaining. |
clearOrderBy()
public ListDataProductsRequest.Builder clearOrderBy()Optional. Order by expression that orders data products listed in the response.
Supported Order by fields are: name or create_time.
If not specified, the ordering is undefined.
Ordering by create_time is not supported when listing resources across
locations (i.e. when request contains /locations/-).
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListDataProductsRequest.Builder clearPageSize()Optional. The maximum number of data products to return. The service may return fewer than this value. If unspecified, at most 50 data products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListDataProductsRequest.Builder clearPageToken() Optional. A page token, received from a previous ListDataProducts call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDataProducts must
match the call that provided the page token.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
This builder for chaining. |
clearParent()
public ListDataProductsRequest.Builder clearParent()Required. The parent, which has this collection of data products.
Format: projects/{project_id_or_number}/locations/{location_id}.
Supports listing across all locations with the wildcard - (hyphen)
character. Example: projects/{project_id_or_number}/locations/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public ListDataProductsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public String getFilter()Optional. Filter expression that filters data products listed in the response.
Example of using this filter is: display_name="my-data-product"
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()Optional. Filter expression that filters data products listed in the response.
Example of using this filter is: display_name="my-data-product"
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getOrderBy()
public String getOrderBy()Optional. Order by expression that orders data products listed in the response.
Supported Order by fields are: name or create_time.
If not specified, the ordering is undefined.
Ordering by create_time is not supported when listing resources across
locations (i.e. when request contains /locations/-).
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()Optional. Order by expression that orders data products listed in the response.
Supported Order by fields are: name or create_time.
If not specified, the ordering is undefined.
Ordering by create_time is not supported when listing resources across
locations (i.e. when request contains /locations/-).
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderBy. |
getPageSize()
public int getPageSize()Optional. The maximum number of data products to return. The service may return fewer than this value. If unspecified, at most 50 data products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken() Optional. A page token, received from a previous ListDataProducts call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDataProducts 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. A page token, received from a previous ListDataProducts call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDataProducts 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 parent, which has this collection of data products.
Format: projects/{project_id_or_number}/locations/{location_id}.
Supports listing across all locations with the wildcard - (hyphen)
character. Example: projects/{project_id_or_number}/locations/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes()Required. The parent, which has this collection of data products.
Format: projects/{project_id_or_number}/locations/{location_id}.
Supports listing across all locations with the wildcard - (hyphen)
character. Example: projects/{project_id_or_number}/locations/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListDataProductsRequest other)
public ListDataProductsRequest.Builder mergeFrom(ListDataProductsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListDataProductsRequest |
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListDataProductsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListDataProductsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
|
setFilter(String value)
public ListDataProductsRequest.Builder setFilter(String value)Optional. Filter expression that filters data products listed in the response.
Example of using this filter is: display_name="my-data-product"
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListDataProductsRequest.Builder setFilterBytes(ByteString value)Optional. Filter expression that filters data products listed in the response.
Example of using this filter is: display_name="my-data-product"
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListDataProductsRequest.Builder setOrderBy(String value)Optional. Order by expression that orders data products listed in the response.
Supported Order by fields are: name or create_time.
If not specified, the ordering is undefined.
Ordering by create_time is not supported when listing resources across
locations (i.e. when request contains /locations/-).
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListDataProductsRequest.Builder setOrderByBytes(ByteString value)Optional. Order by expression that orders data products listed in the response.
Supported Order by fields are: name or create_time.
If not specified, the ordering is undefined.
Ordering by create_time is not supported when listing resources across
locations (i.e. when request contains /locations/-).
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListDataProductsRequest.Builder setPageSize(int value)Optional. The maximum number of data products to return. The service may return fewer than this value. If unspecified, at most 50 data products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListDataProductsRequest.Builder setPageToken(String value) Optional. A page token, received from a previous ListDataProducts call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDataProducts 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 |
ListDataProductsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListDataProductsRequest.Builder setPageTokenBytes(ByteString value) Optional. A page token, received from a previous ListDataProducts call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDataProducts 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 |
ListDataProductsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListDataProductsRequest.Builder setParent(String value)Required. The parent, which has this collection of data products.
Format: projects/{project_id_or_number}/locations/{location_id}.
Supports listing across all locations with the wildcard - (hyphen)
character. Example: projects/{project_id_or_number}/locations/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListDataProductsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListDataProductsRequest.Builder setParentBytes(ByteString value)Required. The parent, which has this collection of data products.
Format: projects/{project_id_or_number}/locations/{location_id}.
Supports listing across all locations with the wildcard - (hyphen)
character. Example: projects/{project_id_or_number}/locations/-
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 |
ListDataProductsRequest.Builder |
This builder for chaining. |