Reference documentation and code samples for the Cloud Composer V1 API class Google::Cloud::Orchestration::Airflow::Service::V1::ListWorkloadsRequest.
Request for listing workloads in a Cloud Composer environment.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
Returns
- (::String) — 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.
#filter=
def filter=(value) -> ::String
Parameter
- value (::String) — 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.
Returns
- (::String) — 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.
#page_size
def page_size() -> ::Integer
Returns
- (::Integer) — Optional. The maximum number of environments to return.
#page_size=
def page_size=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. The maximum number of environments to return.
Returns
- (::Integer) — Optional. The maximum number of environments to return.
#page_token
def page_token() -> ::String
Returns
- (::String) — Optional. The next_page_token value returned from a previous List request, if any.
#page_token=
def page_token=(value) -> ::String
Parameter
- value (::String) — Optional. The next_page_token value returned from a previous List request, if any.
Returns
- (::String) — Optional. The next_page_token value returned from a previous List request, if any.
#parent
def parent() -> ::String
Returns
- (::String) — Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
#parent=
def parent=(value) -> ::String
Parameter
- value (::String) — Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
Returns
- (::String) — Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"