Google Cloud Vmware Engine V1 Client - Class ListPeeringRoutesRequest (0.5.5)

Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class ListPeeringRoutesRequest.

Request message for VmwareEngine.ListPeeringRoutes

Generated from protobuf message google.cloud.vmwareengine.v1.ListPeeringRoutesRequest

Namespace

Google \ Cloud \ VmwareEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The resource name of the network peering to retrieve peering routes from. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering
↳ page_size int

The maximum number of peering routes to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
↳ page_token string

A page token, received from a previous ListPeeringRoutes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPeeringRoutes must match the call that provided the page token.
↳ filter string

A filter expression that matches resources returned in the response. Currently, only filtering on the direction field is supported. To return routes imported from the peer network, provide "direction=INCOMING". To return routes exported from the VMware Engine network, provide "direction=OUTGOING". Other filter expressions return an error.

getParent

Required. The resource name of the network peering to retrieve peering routes from. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

Returns
Type Description
string

setParent

Required. The resource name of the network peering to retrieve peering routes from. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of peering routes to return in one page.

The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.

Returns
Type Description
int

setPageSize

The maximum number of peering routes to return in one page.

The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A page token, received from a previous ListPeeringRoutes call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPeeringRoutes must match the call that provided the page token.

Returns
Type Description
string

setPageToken

A page token, received from a previous ListPeeringRoutes call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPeeringRoutes must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

A filter expression that matches resources returned in the response.

Currently, only filtering on the direction field is supported. To return routes imported from the peer network, provide "direction=INCOMING". To return routes exported from the VMware Engine network, provide "direction=OUTGOING". Other filter expressions return an error.

Returns
Type Description
string

setFilter

A filter expression that matches resources returned in the response.

Currently, only filtering on the direction field is supported. To return routes imported from the peer network, provide "direction=INCOMING". To return routes exported from the VMware Engine network, provide "direction=OUTGOING". Other filter expressions return an error.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the network peering to retrieve peering routes from. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering Please see Google\Cloud\VmwareEngine\V1\VmwareEngineClient::networkPeeringName() for help formatting this field.
Returns
Type Description
Google\Cloud\VmwareEngine\V1\ListPeeringRoutesRequest