Google Cloud Container V1 Client - Class ListUsableSubnetworksRequest (1.9.1)

Reference documentation and code samples for the Google Cloud Container V1 Client class ListUsableSubnetworksRequest.

ListUsableSubnetworksRequest requests the list of usable subnetworks available to a user for creating clusters.

Generated from protobuf message google.container.v1.ListUsableSubnetworksRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

The parent project where subnetworks are usable. Specified in the format projects/*.

↳ filter string

Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where networkProjectId is the project which owns the listed subnetworks. This defaults to the parent project ID.

↳ page_size int

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

↳ page_token string

Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results.

getParent

The parent project where subnetworks are usable.

Specified in the format projects/*.

Generated from protobuf field string parent = 1;

Returns
TypeDescription
string

setParent

The parent project where subnetworks are usable.

Specified in the format projects/*.

Generated from protobuf field string parent = 1;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where networkProjectId is the project which owns the listed subnetworks. This defaults to the parent project ID.

Generated from protobuf field string filter = 2;

Returns
TypeDescription
string

setFilter

Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where networkProjectId is the project which owns the listed subnetworks. This defaults to the parent project ID.

Generated from protobuf field string filter = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

Generated from protobuf field int32 page_size = 3;

Returns
TypeDescription
int

setPageSize

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

Generated from protobuf field int32 page_size = 3;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results.

Generated from protobuf field string page_token = 4;

Returns
TypeDescription
string

setPageToken

Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results.

Generated from protobuf field string page_token = 4;

Parameter
NameDescription
var string
Returns
TypeDescription
$this