Google Cloud Dataproc v1 API - Class ListBatchesRequest (5.8.0)

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

Reference documentation and code samples for the Google Cloud Dataproc v1 API class ListBatchesRequest.

A request to list batch workloads in a project.

Inheritance

object > ListBatchesRequest

Implements

IPageRequest, IMessage ListBatchesRequest, IEquatable ListBatchesRequest, IDeepCloneable ListBatchesRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

ListBatchesRequest()

public ListBatchesRequest()

ListBatchesRequest(ListBatchesRequest)

public ListBatchesRequest(ListBatchesRequest other)

Parameter
Name	Description
`other`	`ListBatchesRequest`

Properties

Filter

public string Filter { get; set; }

Optional. A filter for the batches to return in the response.

A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, and create_time.

e.g. state = RUNNING and create_time < "2023-01-01T00:00:00Z" filters for batches in state RUNNING that were created before 2023-01-01

See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons.

Property Value
Type	Description
`string`

OrderBy

public string OrderBy { get; set; }

Optional. Field(s) on which to sort the list of batches.

Currently the only supported sort orders are unspecified (empty) and create_time desc to sort by most recently created batches first.

See https://google.aip.dev/132#ordering for more details.

Property Value
Type	Description
`string`

PageSize

public int PageSize { get; set; }

Optional. The maximum number of batches to return in each response. The service may return fewer than this value. The default page size is 20; the maximum page size is 1000.

Property Value
Type	Description
`int`

PageToken

public string PageToken { get; set; }

Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.

Property Value
Type	Description
`string`

Parent

public string Parent { get; set; }

Required. The parent, which owns this collection of batches.

Property Value
Type	Description
`string`

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type	Description
`LocationName`