Google Cloud Observability V1 Client - Class ListDatasetsRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Observability V1 Client class ListDatasetsRequest.

Request for listing datasets.

Generated from protobuf message google.cloud.observability.v1.ListDatasetsRequest

Namespace

Google \ Cloud \ Observability \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent bucket that owns this collection of datasets. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

↳ page_size int

Optional. The maximum number of datasets to return. If unspecified, then at most 100 datasets are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

↳ page_token string

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

↳ show_deleted bool

Optional. If true, then the response will include deleted datasets.

getParent

Required. The parent bucket that owns this collection of datasets. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

Returns
Type Description
string

setParent

Required. The parent bucket that owns this collection of datasets. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of datasets to return. If unspecified, then at most 100 datasets are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

Returns
Type Description
int

setPageSize

Optional. The maximum number of datasets to return. If unspecified, then at most 100 datasets are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token, received from a previous ListDatasets call.

Provide this to retrieve the subsequent page.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous ListDatasets call.

Provide this to retrieve the subsequent page.

Parameter
Name Description
var string
Returns
Type Description
$this

getShowDeleted

Optional. If true, then the response will include deleted datasets.

Returns
Type Description
bool

setShowDeleted

Optional. If true, then the response will include deleted datasets.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent bucket that owns this collection of datasets. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID] Please see ObservabilityClient::bucketName() for help formatting this field.

Returns
Type Description
ListDatasetsRequest