Reference documentation and code samples for the Google Cloud Dataproc Metastore V1beta Client class ListServicesRequest.
Request message for DataprocMetastore.ListServices.
Generated from protobuf message google.cloud.metastore.v1beta.ListServicesRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The relative resource name of the location of metastore services to list, in the following form: |
↳ page_size |
int
Optional. The maximum number of services 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 DataprocMetastore.ListServices 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 DataprocMetastore.ListServices 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 services
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 | |
|---|---|
| Type | Description |
string | |
setParent
Required. The relative resource name of the location of metastore services
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Optional. The maximum number of services 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 | |
|---|---|
| Type | Description |
int | |
setPageSize
Optional. The maximum number of services 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 | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
Optional. A page token, received from a previous DataprocMetastore.ListServices 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 DataprocMetastore.ListServices must match the call that provided the page token.
Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Optional. A page token, received from a previous DataprocMetastore.ListServices 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 DataprocMetastore.ListServices must match the call that provided the page token.
Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Optional. The filter to apply to list results.
Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Optional. The filter to apply to list results.
Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |