Console
    Contact Us Start free

    Compute V1 Client - Class Region (1.5.0)

    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

    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.

    ↳ 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.

    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

    getDeprecated

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

    Generated from protobuf field optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;

    Returns
    Type
    Description
    Google\Cloud\Compute\V1\DeprecationStatus |null

    hasDeprecated

    clearDeprecated

    setDeprecated

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

    Generated from protobuf field optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;

    Parameter
    Name
    Description
    var
    Google\Cloud\Compute\V1\DeprecationStatus
    Returns
    Type
    Description
    $this

    getDescription

    [Output Only] Textual description of the resource.

    Generated from protobuf field optional string description = 422937596;

    Returns
    Type
    Description
    string

    hasDescription

    clearDescription

    setDescription

    [Output Only] Textual description of the resource.

    Generated from protobuf field optional string description = 422937596;

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

    Generated from protobuf field optional string kind = 3292052;

    Returns
    Type
    Description
    string

    hasKind

    clearKind

    setKind

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

    Generated from protobuf field optional string kind = 3292052;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getName

    [Output Only] Name of the resource.

    Generated from protobuf field optional string name = 3373707;

    Returns
    Type
    Description
    string

    hasName

    clearName

    setName

    [Output Only] Name of the resource.

    Generated from protobuf field optional string name = 3373707;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getQuotas

    [Output Only] Quotas assigned to this region.

    Generated from protobuf field repeated .google.cloud.compute.v1.Quota quotas = 125341947;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setQuotas

    [Output Only] Quotas assigned to this region.

    Generated from protobuf field repeated .google.cloud.compute.v1.Quota quotas = 125341947;

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Compute\V1\Quota >
    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

    getStatus

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

    Check the Status enum for the list of possible values.

    Generated from protobuf field optional string status = 181260274;

    Returns
    Type
    Description
    string

    hasStatus

    clearStatus

    setStatus

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

    Check the Status enum for the list of possible values.

    Generated from protobuf field optional string status = 181260274;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSupportsPzs

    [Output Only] Reserved for future use.

    Generated from protobuf field optional bool supports_pzs = 83983214;

    Returns
    Type
    Description
    bool

    hasSupportsPzs

    clearSupportsPzs

    setSupportsPzs

    [Output Only] Reserved for future use.

    Generated from protobuf field optional bool supports_pzs = 83983214;

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getZones

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

    Generated from protobuf field repeated string zones = 116085319;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setZones

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

    Generated from protobuf field repeated string zones = 116085319;

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: