Compute V1 Client - Class RoutersListBgpRoutes (1.30.0)

Reference documentation and code samples for the Compute V1 Client class RoutersListBgpRoutes.

Generated from protobuf message google.cloud.compute.v1.RoutersListBgpRoutes

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ etagstring
↳ idstring

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

↳ kindstring

[Output Only] Type of resource. Always compute#routersListBgpRoutes for lists of bgp routes.

↳ next_page_tokenstring

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

↳ resultarray<BgpRoute>

[Output Only] A list of bgp routes.

↳ self_linkstring

[Output Only] Server-defined URL for this resource.

↳ unreachablesarray

[Output Only] Unreachable resources.

↳ warningWarning

[Output Only] Informational warning message.

getEtag

Generated from protobuf field optional string etag = 3123477;

Returns
TypeDescription
string

hasEtag

clearEtag

setEtag

Generated from protobuf field optional string etag = 3123477;

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns
TypeDescription
string

hasId

clearId

setId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getKind

[Output Only] Type of resource. Always compute#routersListBgpRoutes for lists of bgp routes.

Returns
TypeDescription
string

hasKind

clearKind

setKind

[Output Only] Type of resource. Always compute#routersListBgpRoutes for lists of bgp routes.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getNextPageToken

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

Returns
TypeDescription
string

hasNextPageToken

clearNextPageToken

setNextPageToken

[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getResult

[Output Only] A list of bgp routes.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setResult

[Output Only] A list of bgp routes.

Parameter
NameDescription
vararray<BgpRoute>
Returns
TypeDescription
$this

[Output Only] Server-defined URL for this resource.

Returns
TypeDescription
string

[Output Only] Server-defined URL for this resource.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getUnreachables

[Output Only] Unreachable resources.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setUnreachables

[Output Only] Unreachable resources.

Parameter
NameDescription
varstring[]
Returns
TypeDescription
$this

getWarning

[Output Only] Informational warning message.

Returns
TypeDescription
Warning|null

hasWarning

clearWarning

setWarning

[Output Only] Informational warning message.

Parameter
NameDescription
varWarning
Returns
TypeDescription
$this