Google Cloud Dataproc Metastore V1beta Client - Class ListFederationsRequest (0.4.1)

Reference documentation and code samples for the Google Cloud Dataproc Metastore V1beta Client class ListFederationsRequest.

Request message for ListFederations.

Generated from protobuf message google.cloud.metastore.v1beta.ListFederationsRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.

↳ page_size int

Optional. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.

↳ page_token string

Optional. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page. To retrieve the first page, supply an empty page token. When paginating, other parameters provided to ListFederationServices must match the call that provided the page token.

↳ filter string

Optional. The filter to apply to list results.

↳ order_by string

Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.

getParent

Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.

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

Returns
TypeDescription
string

setParent

Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_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. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.

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

Returns
TypeDescription
int

setPageSize

Optional. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 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 ListFederationServices call. Provide this token to retrieve the subsequent page.

To retrieve the first page, supply an empty page token. When paginating, other parameters provided to ListFederationServices 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. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page.

To retrieve the first page, supply an empty page token. When paginating, other parameters provided to ListFederationServices 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. The filter to apply to list results.

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

Returns
TypeDescription
string

setFilter

Optional. The filter to apply to list results.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

Optional. Specify the ordering of results as described in Sorting Order.

If not specified, the results will be sorted in the default order.

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

Returns
TypeDescription
string

setOrderBy

Optional. Specify the ordering of results as described in Sorting Order.

If not specified, the results will be sorted in the default order.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this