Google Cloud Network Connectivity V1 Client - Class QueryHubStatusRequest (2.1.0)

Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class QueryHubStatusRequest.

The request for HubService.QueryHubStatus.

Generated from protobuf message google.cloud.networkconnectivity.v1.QueryHubStatusRequest

Namespace

Google \ Cloud \ NetworkConnectivity \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The name of the hub.
↳ page_size int

Optional. The maximum number of results to return per page.
↳ page_token string

Optional. The page token.
↳ filter string

Optional. An expression that filters the list of results. The filter can be used to filter the results by the following fields: * * psc_propagation_status.source_spoke * * psc_propagation_status.source_group * * psc_propagation_status.source_forwarding_rule * * psc_propagation_status.target_spoke * * psc_propagation_status.target_group * * psc_propagation_status.code * * psc_propagation_status.message
↳ order_by string

Optional. Sort the results in ascending order by the specified fields. A comma-separated list of any of these fields: * * psc_propagation_status.source_spoke * * psc_propagation_status.source_group * * psc_propagation_status.source_forwarding_rule * * psc_propagation_status.target_spoke * * psc_propagation_status.target_group * * psc_propagation_status.code If group_by is set, the value of the order_by field must be the same as or a subset of the group_by field.
↳ group_by string

Optional. Aggregate the results by the specified fields. A comma-separated list of any of these fields: * * psc_propagation_status.source_spoke * * psc_propagation_status.source_group * * psc_propagation_status.source_forwarding_rule * * psc_propagation_status.target_spoke * * psc_propagation_status.target_group * * psc_propagation_status.code

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

getPageSize

Optional. The maximum number of results to return per page.

Returns
Type Description
int

setPageSize

Optional. The maximum number of results to return per page.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. The page token.

Returns
Type Description
string

setPageToken

Optional. The page token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. An expression that filters the list of results.

The filter can be used to filter the results by the following fields:

  • psc_propagation_status.source_spoke
  • psc_propagation_status.source_group
  • psc_propagation_status.source_forwarding_rule
  • psc_propagation_status.target_spoke
  • psc_propagation_status.target_group
  • psc_propagation_status.code
  • psc_propagation_status.message
Returns
Type Description
string

setFilter

Optional. An expression that filters the list of results.

The filter can be used to filter the results by the following fields:

  • psc_propagation_status.source_spoke
  • psc_propagation_status.source_group
  • psc_propagation_status.source_forwarding_rule
  • psc_propagation_status.target_spoke
  • psc_propagation_status.target_group
  • psc_propagation_status.code
  • psc_propagation_status.message
Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Sort the results in ascending order by the specified fields.

A comma-separated list of any of these fields:

  • psc_propagation_status.source_spoke
  • psc_propagation_status.source_group
  • psc_propagation_status.source_forwarding_rule
  • psc_propagation_status.target_spoke
  • psc_propagation_status.target_group
  • psc_propagation_status.code If group_by is set, the value of the order_by field must be the same as or a subset of the group_by field.
Returns
Type Description
string

setOrderBy

Optional. Sort the results in ascending order by the specified fields.

A comma-separated list of any of these fields:

  • psc_propagation_status.source_spoke
  • psc_propagation_status.source_group
  • psc_propagation_status.source_forwarding_rule
  • psc_propagation_status.target_spoke
  • psc_propagation_status.target_group
  • psc_propagation_status.code If group_by is set, the value of the order_by field must be the same as or a subset of the group_by field.
Parameter
Name Description
var string
Returns
Type Description
$this

getGroupBy

Optional. Aggregate the results by the specified fields.

A comma-separated list of any of these fields:

  • psc_propagation_status.source_spoke
  • psc_propagation_status.source_group
  • psc_propagation_status.source_forwarding_rule
  • psc_propagation_status.target_spoke
  • psc_propagation_status.target_group
  • psc_propagation_status.code
Returns
Type Description
string

setGroupBy

Optional. Aggregate the results by the specified fields.

A comma-separated list of any of these fields:

  • psc_propagation_status.source_spoke
  • psc_propagation_status.source_group
  • psc_propagation_status.source_forwarding_rule
  • psc_propagation_status.target_spoke
  • psc_propagation_status.target_group
  • psc_propagation_status.code
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the hub. Please see HubServiceClient::hubName() for help formatting this field.
Returns
Type Description
QueryHubStatusRequest