Compute V1 Client - Class NetworkAttachment (1.17.0)

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

NetworkAttachments A network attachment resource ...

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ connection_endpoints array<Google\Cloud\Compute\V1\NetworkAttachmentConnectedEndpoint>

[Output Only] An array of connections for all the producers connected to this network attachment.
↳ connection_preference string

Check the ConnectionPreference enum for the list of possible values.
↳ creation_timestamp string

[Output Only] Creation timestamp in RFC3339 text format.
↳ description string

An optional description of this resource. Provide this property when you create the resource.
↳ fingerprint string

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.
↳ id int|string

[Output Only] The unique identifier for the resource type. The server generates this identifier.
↳ kind string

[Output Only] Type of the resource.
↳ name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
↳ network string

[Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks.
↳ producer_accept_lists array

Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.
↳ producer_reject_lists array

Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.
↳ region string

[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
↳ self_link string

[Output Only] Server-defined URL for the resource.
↳ self_link_with_id string

[Output Only] Server-defined URL for this resource's resource id.
↳ subnetworks array

An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.

getConnectionEndpoints

[Output Only] An array of connections for all the producers connected to this network attachment.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setConnectionEndpoints

[Output Only] An array of connections for all the producers connected to this network attachment.

Parameter
Name Description
var array<Google\Cloud\Compute\V1\NetworkAttachmentConnectedEndpoint>
Returns
Type Description
$this

getConnectionPreference

Check the ConnectionPreference enum for the list of possible values.

Returns
Type Description
string

hasConnectionPreference

clearConnectionPreference

setConnectionPreference

Check the ConnectionPreference enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

An optional description of this resource. Provide this property when you create the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getFingerprint

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.

Returns
Type Description
string

hasFingerprint

clearFingerprint

setFingerprint

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.

Parameter
Name Description
var string
Returns
Type Description
$this

getId

[Output Only] The unique identifier for the resource type. The server generates this identifier.

Returns
Type Description
int|string

hasId

clearId

setId

[Output Only] The unique identifier for the resource type. The server generates this identifier.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getKind

[Output Only] Type of the resource.

Returns
Type Description
string

hasKind

clearKind

setKind

[Output Only] Type of the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type Description
string

hasName

clearName

setName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameter
Name Description
var string
Returns
Type Description
$this

getNetwork

[Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks.

Returns
Type Description
string

hasNetwork

clearNetwork

setNetwork

[Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks.

Parameter
Name Description
var string
Returns
Type Description
$this

getProducerAcceptLists

Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setProducerAcceptLists

Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getProducerRejectLists

Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setProducerRejectLists

Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getRegion

[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Returns
Type Description
string

hasRegion

clearRegion

setRegion

[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLink

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

Returns
Type Description
string

hasSelfLink

clearSelfLink

setSelfLink

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLinkWithId

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

Returns
Type Description
string

hasSelfLinkWithId

clearSelfLinkWithId

setSelfLinkWithId

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSubnetworks

An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSubnetworks

An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.

Parameter
Name Description
var string[]
Returns
Type Description
$this