ListHubSpokesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The request for HubService.ListHubSpokes.
Attributes |
|
---|---|
Name | Description |
name |
str
Required. The name of the hub. |
spoke_locations |
MutableSequence[str]
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.
|
page_size |
int
The maximum number of results to return per page. |
page_token |
str
The page token. |
filter |
str
An expression that filters the list of results. |
order_by |
str
Sort the results by name or create_time. |
view |
google.cloud.networkconnectivity_v1.types.ListHubSpokesRequest.SpokeView
The view of the spoke to return. The view that you use determines which spoke fields are included in the response. |
Classes
SpokeView
SpokeView(value)
Enum that controls which spoke fields are included in the response.
Values:
SPOKE_VIEW_UNSPECIFIED (0):
The spoke view is unspecified. When the spoke view is
unspecified, the API returns the same fields as the
BASIC
view.
BASIC (1):
Includes name
, create_time
, hub
, unique_id
,
state
, reasons
, and spoke_type
. This is the
default value.
DETAILED (2):
Includes all spoke fields except labels
. You can use the
DETAILED
view only when you set the spoke_locations
field to [global]
.