Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class ListHubSpokesRequest.
The request for HubService.ListHubSpokes.
Generated from protobuf message google.cloud.networkconnectivity.v1.ListHubSpokesRequest
Namespace
Google \ Cloud \ NetworkConnectivity \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the hub. |
↳ spoke_locations |
array
A list of locations. Specify one of the following: |
↳ page_size |
int
The maximum number of results to return per page. |
↳ page_token |
string
The page token. |
↳ filter |
string
An expression that filters the list of results. |
↳ order_by |
string
Sort the results by name or create_time. |
↳ view |
int
The view of the spoke to return. The view that you use determines which spoke fields are included in the response. |
getName
Required. The name of the hub.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The name of the hub.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSpokeLocations
A list of locations.
Specify one of the following: [global], a single region (for
example, [us-central1]), or a combination of
values (for example, [global, us-central1, us-west1]).
If the spoke_locations field is populated, the list of results
includes only spokes in the specified location.
If the spoke_locations field is not populated, the list of results
includes spokes in all locations.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSpokeLocations
A list of locations.
Specify one of the following: [global], a single region (for
example, [us-central1]), or a combination of
values (for example, [global, us-central1, us-west1]).
If the spoke_locations field is populated, the list of results
includes only spokes in the specified location.
If the spoke_locations field is not populated, the list of results
includes spokes in all locations.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The maximum number of results to return per page.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
The maximum number of results to return per page.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
The page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
The page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
An expression that filters the list of results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
An expression that filters the list of results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Sort the results by name or create_time.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Sort the results by name or create_time.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getView
The view of the spoke to return.
The view that you use determines which spoke fields are included in the response.
| Returns | |
|---|---|
| Type | Description |
int |
|
setView
The view of the spoke to return.
The view that you use determines which spoke fields are included in the response.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The name of the hub. Please see Google\Cloud\NetworkConnectivity\V1\HubServiceClient::hubName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\NetworkConnectivity\V1\ListHubSpokesRequest |
|