Compute V1 Client - Class NetworkEdgeSecurityService (1.5.0)

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

Represents a Google Cloud Armor network edge security service resource.

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ 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. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.
`↳ id`	`int\|string` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`↳ kind`	`string` [Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices
`↳ 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.
`↳ region`	`string` [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`↳ security_policy`	`string` The resource URL for the network edge security service associated with this network edge security service.
`↳ self_link`	`string` [Output Only] Server-defined URL for the resource.
`↳ self_link_with_id`	`string` [Output Only] Server-defined URL for this resource with the resource id.

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Returns
Type	Description
`string`

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

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

Generated from protobuf field optional string description = 422937596;

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

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

Generated from protobuf field optional string description = 422937596;

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. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.

Generated from protobuf field optional string fingerprint = 234678500;

Returns
Type	Description
`string`

hasFingerprint

clearFingerprint

setFingerprint

Generated from protobuf field optional string fingerprint = 234678500;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getId

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

Generated from protobuf field optional uint64 id = 3355;

Returns
Type	Description
`int\|string`

hasId

clearId

setId

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

Generated from protobuf field optional uint64 id = 3355;

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getKind

[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices

Generated from protobuf field optional string kind = 3292052;

Returns
Type	Description
`string`

hasKind

clearKind

setKind

[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices

Generated from protobuf field optional string kind = 3292052;

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.

Generated from protobuf field optional string name = 3373707;

Returns
Type	Description
`string`

hasName

clearName

setName

Generated from protobuf field optional string name = 3373707;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRegion

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

Generated from protobuf field optional string region = 138946292;

Returns
Type	Description
`string`

hasRegion

clearRegion

setRegion

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

Generated from protobuf field optional string region = 138946292;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSecurityPolicy

The resource URL for the network edge security service associated with this network edge security service.

Generated from protobuf field optional string security_policy = 171082513;

Returns
Type	Description
`string`

hasSecurityPolicy

clearSecurityPolicy

setSecurityPolicy

The resource URL for the network edge security service associated with this network edge security service.

Generated from protobuf field optional string security_policy = 171082513;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSelfLink

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

Generated from protobuf field optional string self_link = 456214797;

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

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

Generated from protobuf field optional string self_link = 456214797;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSelfLinkWithId

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

Generated from protobuf field optional string self_link_with_id = 44520962;

Returns
Type	Description
`string`

hasSelfLinkWithId

clearSelfLinkWithId

setSelfLinkWithId

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

Generated from protobuf field optional string self_link_with_id = 44520962;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`