Cloud Composer v1 API - Class ListWorkloadsRequest (2.5.0)

public sealed class ListWorkloadsRequest : IMessage<ListWorkloadsRequest>, IEquatable<ListWorkloadsRequest>, IDeepCloneable<ListWorkloadsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Cloud Composer v1 API class ListWorkloadsRequest.

Request for listing workloads in a Cloud Composer environment.

Inheritance

object > ListWorkloadsRequest

Namespace

Google.Cloud.Orchestration.Airflow.Service.V1

Assembly

Google.Cloud.Orchestration.Airflow.Service.V1.dll

Constructors

ListWorkloadsRequest()

public ListWorkloadsRequest()

ListWorkloadsRequest(ListWorkloadsRequest)

public ListWorkloadsRequest(ListWorkloadsRequest other)
Parameter
NameDescription
otherListWorkloadsRequest

Properties

Filter

public string Filter { get; set; }

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.

Property Value
TypeDescription
string

PageSize

public int PageSize { get; set; }

Optional. The maximum number of environments to return.

Property Value
TypeDescription
int

PageToken

public string PageToken { get; set; }

Optional. The next_page_token value returned from a previous List request, if any.

Property Value
TypeDescription
string

Parent

public string Parent { get; set; }

Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Property Value
TypeDescription
string

ParentAsEnvironmentName

public EnvironmentName ParentAsEnvironmentName { get; set; }

EnvironmentName-typed view over the Parent resource name property.

Property Value
TypeDescription
EnvironmentName