Compute V1 Client - Class Region (1.9.1)

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

Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ creation_timestamp string

[Output Only] Creation timestamp in RFC3339 text format.

↳ deprecated Google\Cloud\Compute\V1\DeprecationStatus

[Output Only] The deprecation status associated with this region.

↳ description string

[Output Only] Textual description of the resource.

↳ 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#region for regions.

↳ name string

[Output Only] Name of the resource.

↳ quotas array<Google\Cloud\Compute\V1\Quota>

[Output Only] Quotas assigned to this region.

↳ self_link string

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

↳ status string

[Output Only] Status of the region, either UP or DOWN. Check the Status enum for the list of possible values.

↳ supports_pzs bool

[Output Only] Reserved for future use.

↳ zones array

[Output Only] A list of zones available in this region, in the form of resource URLs.

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
TypeDescription
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDeprecated

[Output Only] The deprecation status associated with this region.

Returns
TypeDescription
Google\Cloud\Compute\V1\DeprecationStatus|null

hasDeprecated

clearDeprecated

setDeprecated

[Output Only] The deprecation status associated with this region.

Parameter
NameDescription
var Google\Cloud\Compute\V1\DeprecationStatus
Returns
TypeDescription
$this

getDescription

[Output Only] Textual description of the resource.

Returns
TypeDescription
string

hasDescription

clearDescription

setDescription

[Output Only] Textual description of the resource.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

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

Returns
TypeDescription
int|string

hasId

clearId

setId

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getKind

[Output Only] Type of the resource. Always compute#region for regions.

Returns
TypeDescription
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#region for regions.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

[Output Only] Name of the resource.

Returns
TypeDescription
string

hasName

clearName

setName

[Output Only] Name of the resource.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getQuotas

[Output Only] Quotas assigned to this region.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setQuotas

[Output Only] Quotas assigned to this region.

Parameter
NameDescription
var array<Google\Cloud\Compute\V1\Quota>
Returns
TypeDescription
$this

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

Returns
TypeDescription
string

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStatus

[Output Only] Status of the region, either UP or DOWN.

Check the Status enum for the list of possible values.

Returns
TypeDescription
string

hasStatus

clearStatus

setStatus

[Output Only] Status of the region, either UP or DOWN.

Check the Status enum for the list of possible values.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSupportsPzs

[Output Only] Reserved for future use.

Returns
TypeDescription
bool

hasSupportsPzs

clearSupportsPzs

setSupportsPzs

[Output Only] Reserved for future use.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getZones

[Output Only] A list of zones available in this region, in the form of resource URLs.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setZones

[Output Only] A list of zones available in this region, in the form of resource URLs.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this