Google Cloud Vmware Engine V1 Client - Class PrivateConnection (0.5.6)

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

Private connection resource that provides connectivity for VMware Engine private clouds.

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

Namespace

Google \ Cloud \ VmwareEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Output only. The resource name of the private connection. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateConnections/my-connection
↳ create_time Google\Protobuf\Timestamp

Output only. Creation time of this resource.
↳ update_time Google\Protobuf\Timestamp

Output only. Last update time of this resource.
↳ description string

Optional. User-provided description for this private connection.
↳ state int

Output only. State of the private connection.
↳ vmware_engine_network string

Required. The relative resource name of Legacy VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id} where {project}, {location} will be same as specified in private connection resource name and {vmware_engine_network_id} will be in the form of {location}-default e.g. projects/project/locations/us-central1/vmwareEngineNetworks/us-central1-default.
↳ vmware_engine_network_canonical string

Output only. The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}
↳ type int

Required. Private connection type.
↳ peering_id string

Output only. VPC network peering id between given network VPC and VMwareEngineNetwork.
↳ routing_mode int

Optional. Routing Mode. Default value is set to GLOBAL. For type = PRIVATE_SERVICE_ACCESS, this field can be set to GLOBAL or REGIONAL, for other types only GLOBAL is supported.
↳ uid string

Output only. System-generated unique identifier for the resource.
↳ service_network string

Required. Service network to create private connection. Specify the name in the following form: projects/{project}/global/networks/{network_id} For type = PRIVATE_SERVICE_ACCESS, this field represents servicenetworking VPC, e.g. projects/project-tp/global/networks/servicenetworking. For type = NETAPP_CLOUD_VOLUME, this field represents NetApp service VPC, e.g. projects/project-tp/global/networks/netapp-tenant-vpc. For type = DELL_POWERSCALE, this field represent Dell service VPC, e.g. projects/project-tp/global/networks/dell-tenant-vpc. For type= THIRD_PARTY_SERVICE, this field could represent a consumer VPC or any other producer VPC to which the VMware Engine Network needs to be connected, e.g. projects/project/global/networks/vpc.
↳ peering_state int

Output only. Peering state between service network and VMware Engine network.

getName

Output only. The resource name of the private connection.

Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateConnections/my-connection

Returns
Type Description
string

setName

Output only. The resource name of the private connection.

Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/privateConnections/my-connection

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Creation time of this resource.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time of this resource.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Last update time of this resource.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Last update time of this resource.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDescription

Optional. User-provided description for this private connection.

Returns
Type Description
string

setDescription

Optional. User-provided description for this private connection.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. State of the private connection.

Returns
Type Description
int

setState

Output only. State of the private connection.

Parameter
Name Description
var int
Returns
Type Description
$this

getVmwareEngineNetwork

Required. The relative resource name of Legacy VMware Engine network.

Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id} where {project}, {location} will be same as specified in private connection resource name and {vmware_engine_network_id} will be in the form of {location}-default e.g. projects/project/locations/us-central1/vmwareEngineNetworks/us-central1-default.

Returns
Type Description
string

setVmwareEngineNetwork

Required. The relative resource name of Legacy VMware Engine network.

Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id} where {project}, {location} will be same as specified in private connection resource name and {vmware_engine_network_id} will be in the form of {location}-default e.g. projects/project/locations/us-central1/vmwareEngineNetworks/us-central1-default.

Parameter
Name Description
var string
Returns
Type Description
$this

getVmwareEngineNetworkCanonical

Output only. The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}

Returns
Type Description
string

setVmwareEngineNetworkCanonical

Output only. The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getType

Required. Private connection type.

Returns
Type Description
int

setType

Required. Private connection type.

Parameter
Name Description
var int
Returns
Type Description
$this

getPeeringId

Output only. VPC network peering id between given network VPC and VMwareEngineNetwork.

Returns
Type Description
string

setPeeringId

Output only. VPC network peering id between given network VPC and VMwareEngineNetwork.

Parameter
Name Description
var string
Returns
Type Description
$this

getRoutingMode

Optional. Routing Mode.

Default value is set to GLOBAL. For type = PRIVATE_SERVICE_ACCESS, this field can be set to GLOBAL or REGIONAL, for other types only GLOBAL is supported.

Returns
Type Description
int

setRoutingMode

Optional. Routing Mode.

Default value is set to GLOBAL. For type = PRIVATE_SERVICE_ACCESS, this field can be set to GLOBAL or REGIONAL, for other types only GLOBAL is supported.

Parameter
Name Description
var int
Returns
Type Description
$this

getUid

Output only. System-generated unique identifier for the resource.

Returns
Type Description
string

setUid

Output only. System-generated unique identifier for the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceNetwork

Required. Service network to create private connection.

Specify the name in the following form: projects/{project}/global/networks/{network_id} For type = PRIVATE_SERVICE_ACCESS, this field represents servicenetworking VPC, e.g. projects/project-tp/global/networks/servicenetworking. For type = NETAPP_CLOUD_VOLUME, this field represents NetApp service VPC, e.g. projects/project-tp/global/networks/netapp-tenant-vpc. For type = DELL_POWERSCALE, this field represent Dell service VPC, e.g. projects/project-tp/global/networks/dell-tenant-vpc. For type= THIRD_PARTY_SERVICE, this field could represent a consumer VPC or any other producer VPC to which the VMware Engine Network needs to be connected, e.g. projects/project/global/networks/vpc.

Returns
Type Description
string

setServiceNetwork

Required. Service network to create private connection.

Specify the name in the following form: projects/{project}/global/networks/{network_id} For type = PRIVATE_SERVICE_ACCESS, this field represents servicenetworking VPC, e.g. projects/project-tp/global/networks/servicenetworking. For type = NETAPP_CLOUD_VOLUME, this field represents NetApp service VPC, e.g. projects/project-tp/global/networks/netapp-tenant-vpc. For type = DELL_POWERSCALE, this field represent Dell service VPC, e.g. projects/project-tp/global/networks/dell-tenant-vpc. For type= THIRD_PARTY_SERVICE, this field could represent a consumer VPC or any other producer VPC to which the VMware Engine Network needs to be connected, e.g. projects/project/global/networks/vpc.

Parameter
Name Description
var string
Returns
Type Description
$this

getPeeringState

Output only. Peering state between service network and VMware Engine network.

Returns
Type Description
int

setPeeringState

Output only. Peering state between service network and VMware Engine network.

Parameter
Name Description
var int
Returns
Type Description
$this