Class ListWorkloadsRequest.Builder (1.41.0)

public static final class ListWorkloadsRequest.Builder extends GeneratedMessageV3.Builder<ListWorkloadsRequest.Builder> implements ListWorkloadsRequestOrBuilder

Request for listing workloads in a Cloud Composer environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.ListWorkloadsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListWorkloadsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListWorkloadsRequest.Builder
Overrides

build()

public ListWorkloadsRequest build()
Returns
TypeDescription
ListWorkloadsRequest

buildPartial()

public ListWorkloadsRequest buildPartial()
Returns
TypeDescription
ListWorkloadsRequest

clear()

public ListWorkloadsRequest.Builder clear()
Returns
TypeDescription
ListWorkloadsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListWorkloadsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListWorkloadsRequest.Builder
Overrides

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
TypeDescription
ListWorkloadsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListWorkloadsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListWorkloadsRequest.Builder
Overrides

clearPageSize()

public ListWorkloadsRequest.Builder clearPageSize()

Optional. The maximum number of environments to return.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ListWorkloadsRequest.Builder

This builder for chaining.

clone()

public ListWorkloadsRequest.Builder clone()
Returns
TypeDescription
ListWorkloadsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListWorkloadsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListWorkloadsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListWorkloadsRequest other)

public ListWorkloadsRequest.Builder mergeFrom(ListWorkloadsRequest other)
Parameter
NameDescription
otherListWorkloadsRequest
Returns
TypeDescription
ListWorkloadsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListWorkloadsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListWorkloadsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListWorkloadsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListWorkloadsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListWorkloadsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListWorkloadsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListWorkloadsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListWorkloadsRequest.Builder
Overrides

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
NameDescription
valueString

The filter to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListWorkloadsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListWorkloadsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListWorkloadsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListWorkloadsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListWorkloadsRequest.Builder
Overrides