- 1.78.0 (latest)
 - 1.76.0
 - 1.75.0
 - 1.74.0
 - 1.73.0
 - 1.72.0
 - 1.70.0
 - 1.68.0
 - 1.67.0
 - 1.64.0
 - 1.63.0
 - 1.62.0
 - 1.60.0
 - 1.59.0
 - 1.58.0
 - 1.57.0
 - 1.56.0
 - 1.55.0
 - 1.54.0
 - 1.53.0
 - 1.52.0
 - 1.51.0
 - 1.49.0
 - 1.48.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.37.0
 - 1.36.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.24.0
 - 1.23.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.9.0
 - 1.8.0
 - 1.7.0
 - 1.6.0
 - 1.5.0
 - 1.4.0
 
public static final class ListWorkloadsRequest.Builder extends GeneratedMessageV3.Builder<ListWorkloadsRequest.Builder> implements ListWorkloadsRequestOrBuilderRequest for listing workloads in a Cloud Composer environment.
 Protobuf type google.cloud.orchestration.airflow.service.v1beta1.ListWorkloadsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListWorkloadsRequest.BuilderImplements
ListWorkloadsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListWorkloadsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
ListWorkloadsRequest.Builder | 
        |
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 | 
        |
clearField(Descriptors.FieldDescriptor field)
public ListWorkloadsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
| 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.  | 
      
clearOneof(Descriptors.OneofDescriptor oneof)
public ListWorkloadsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
oneof | 
        OneofDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
ListWorkloadsRequest.Builder | 
        |
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.  | 
      
clone()
public ListWorkloadsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description | 
ListWorkloadsRequest.Builder | 
        |
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 GeneratedMessageV3.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 | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListWorkloadsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
ListWorkloadsRequest.Builder | 
        |
setField(Descriptors.FieldDescriptor field, Object value)
public ListWorkloadsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| 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.  | 
      
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListWorkloadsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
index | 
        int | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
ListWorkloadsRequest.Builder | 
        |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListWorkloadsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
ListWorkloadsRequest.Builder | 
        |