Google Cloud Dataproc V1 Client - Class ListBatchesRequest (3.2.2)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class ListBatchesRequest.

A request to list batch workloads in a project.

Generated from protobuf message google.cloud.dataproc.v1.ListBatchesRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ page_size int

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.

↳ page_token string

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

getParent

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setParent

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

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.

Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

setPageSize

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.

Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Optional. A page token received from a previous ListBatches call.

Provide this token to retrieve the subsequent page.

Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
string

setPageToken

Optional. A page token received from a previous ListBatches call.

Provide this token to retrieve the subsequent page.

Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var string
Returns
TypeDescription
$this