Google Cloud Dataplex V1 Client - Class ListEnvironmentsRequest (0.1.6)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListEnvironmentsRequest.

List environments request.

Generated from protobuf message google.cloud.dataplex.v1.ListEnvironmentsRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}

↳ page_size int

Optional. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

↳ page_token string

Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token.

↳ filter string

Optional. Filter request.

↳ order_by string

Optional. Order by fields for the result.

getParent

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}

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

Returns
TypeDescription
string

setParent

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}

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. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
TypeDescription
int

setPageSize

Optional. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token.

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

Returns
TypeDescription
string

setPageToken

Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Optional. Filter request.

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

Returns
TypeDescription
string

setFilter

Optional. Filter request.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

Optional. Order by fields for the result.

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

Returns
TypeDescription
string

setOrderBy

Optional. Order by fields for the result.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this