public static final class ListWorkloadsRequest.Builder extends GeneratedMessage.Builder<ListWorkloadsRequest.Builder> implements ListWorkloadsRequestOrBuilderRequest for listing workloads in a Cloud Composer environment.
Protobuf type google.cloud.orchestration.airflow.service.v1beta1.ListWorkloadsRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListWorkloadsRequest.BuilderImplements
ListWorkloadsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public ListWorkloadsRequest build()| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest |
|
buildPartial()
public ListWorkloadsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest |
|
clear()
public ListWorkloadsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
|
clearFilter()
public ListWorkloadsRequest.Builder clearFilter()Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListWorkloadsRequest.Builder clearPageSize()Optional. The maximum number of environments to return.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListWorkloadsRequest.Builder clearPageToken()Optional. The next_page_token value returned from a previous List request, if any.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
This builder for chaining. |
clearParent()
public ListWorkloadsRequest.Builder clearParent()Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public ListWorkloadsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public String getFilter()Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getPageSize()
public int getPageSize()Optional. The maximum number of environments to return.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken()Optional. The next_page_token value returned from a previous List request, if any.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()Optional. The next_page_token value returned from a previous List request, if any.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public String getParent()Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes()Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
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(ListWorkloadsRequest other)
public ListWorkloadsRequest.Builder mergeFrom(ListWorkloadsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListWorkloadsRequest |
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListWorkloadsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListWorkloadsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
|
setFilter(String value)
public ListWorkloadsRequest.Builder setFilter(String value)Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListWorkloadsRequest.Builder setFilterBytes(ByteString value)Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListWorkloadsRequest.Builder setPageSize(int value)Optional. The maximum number of environments to return.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListWorkloadsRequest.Builder setPageToken(String value)Optional. The next_page_token value returned from a previous List request, if any.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListWorkloadsRequest.Builder setPageTokenBytes(ByteString value)Optional. The next_page_token value returned from a previous List request, if any.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListWorkloadsRequest.Builder setParent(String value)Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListWorkloadsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListWorkloadsRequest.Builder setParentBytes(ByteString value)Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
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 |
ListWorkloadsRequest.Builder |
This builder for chaining. |