Reference documentation and code samples for the Google Cloud Gke Hub V1 Client class ListFeaturesRequest.
Request message for GkeHub.ListFeatures method.
Generated from protobuf message google.cloud.gkehub.v1.ListFeaturesRequest
Namespace
Google \ Cloud \ GkeHub \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent (project and location) where the Features will be listed. Specified in the format |
↳ page_size |
int
When requesting a 'page' of resources, |
↳ page_token |
string
Token returned by previous call to |
↳ filter |
string
Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Feature with the name "servicemesh" in project "foo-proj": name = "projects/foo-proj/locations/global/features/servicemesh" - Features that have a label called |
↳ order_by |
string
One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering. |
↳ return_partial_success |
bool
Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable. |
getParent
Required. The parent (project and location) where the Features will be
listed. Specified in the format projects/*/locations/*.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent (project and location) where the Features will be
listed. Specified in the format projects/*/locations/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
When requesting a 'page' of resources, page_size specifies number of
resources to return. If unspecified or set to 0, all resources will
be returned.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
When requesting a 'page' of resources, page_size specifies number of
resources to return. If unspecified or set to 0, all resources will
be returned.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Token returned by previous call to ListFeatures which
specifies the position in the list from where to continue listing the
resources.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Token returned by previous call to ListFeatures which
specifies the position in the list from where to continue listing the
resources.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
Examples:
- Feature with the name "servicemesh" in project "foo-proj": name = "projects/foo-proj/locations/global/features/servicemesh"
- Features that have a label called
foo: labels.foo:* - Features that have a label called
foowhose value isbar: labels.foo = bar
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
Examples:
- Feature with the name "servicemesh" in project "foo-proj": name = "projects/foo-proj/locations/global/features/servicemesh"
- Features that have a label called
foo: labels.foo:* - Features that have a label called
foowhose value isbar: labels.foo = bar
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
One or more fields to compare and use to sort the output.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
One or more fields to compare and use to sort the output.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReturnPartialSuccess
Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReturnPartialSuccess
Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent (project and location) where the Features will be
listed. Specified in the format |
| Returns | |
|---|---|
| Type | Description |
ListFeaturesRequest |
|