Class Region (1.54.0)

public final class Region extends GeneratedMessageV3 implements RegionOrBuilder

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

Protobuf type google.cloud.compute.v1.Region

Implements

RegionOrBuilder

Static Fields

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DEPRECATED_FIELD_NUMBER

public static final int DEPRECATED_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

QUOTAS_FIELD_NUMBER

public static final int QUOTAS_FIELD_NUMBER
Field Value
Type Description
int

QUOTA_STATUS_WARNING_FIELD_NUMBER

public static final int QUOTA_STATUS_WARNING_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTS_PZS_FIELD_NUMBER

public static final int SUPPORTS_PZS_FIELD_NUMBER
Field Value
Type Description
int

ZONES_FIELD_NUMBER

public static final int ZONES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Region getDefaultInstance()
Returns
Type Description
Region

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Region.Builder newBuilder()
Returns
Type Description
Region.Builder

newBuilder(Region prototype)

public static Region.Builder newBuilder(Region prototype)
Parameter
Name Description
prototype Region
Returns
Type Description
Region.Builder

parseDelimitedFrom(InputStream input)

public static Region parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Region
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Region parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Region
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Region parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Region
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Region parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Region
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Region parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Region
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Region parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Region
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Region parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Region
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Region parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Region
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Region parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Region
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Region parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Region
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Region parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Region
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Region parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Region
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Region> parser()
Returns
Type Description
Parser<Region>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public Region getDefaultInstanceForType()
Returns
Type Description
Region

getDeprecated()

public DeprecationStatus getDeprecated()

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

optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;

Returns
Type Description
DeprecationStatus

The deprecated.

getDeprecatedOrBuilder()

public DeprecationStatusOrBuilder getDeprecatedOrBuilder()

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

optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;

Returns
Type Description
DeprecationStatusOrBuilder

getDescription()

public String getDescription()

[Output Only] Textual description of the resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

[Output Only] Textual description of the resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getId()

public long getId()

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

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getName()

public String getName()

[Output Only] Name of the resource.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

[Output Only] Name of the resource.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Region> getParserForType()
Returns
Type Description
Parser<Region>
Overrides

getQuotaStatusWarning()

public QuotaStatusWarning getQuotaStatusWarning()

[Output Only] Warning of fetching the quotas field for this region. This field is populated only if fetching of the quotas field fails.

optional .google.cloud.compute.v1.QuotaStatusWarning quota_status_warning = 302941430;

Returns
Type Description
QuotaStatusWarning

The quotaStatusWarning.

getQuotaStatusWarningOrBuilder()

public QuotaStatusWarningOrBuilder getQuotaStatusWarningOrBuilder()

[Output Only] Warning of fetching the quotas field for this region. This field is populated only if fetching of the quotas field fails.

optional .google.cloud.compute.v1.QuotaStatusWarning quota_status_warning = 302941430;

Returns
Type Description
QuotaStatusWarningOrBuilder

getQuotas(int index)

public Quota getQuotas(int index)

[Output Only] Quotas assigned to this region.

repeated .google.cloud.compute.v1.Quota quotas = 125341947;

Parameter
Name Description
index int
Returns
Type Description
Quota

getQuotasCount()

public int getQuotasCount()

[Output Only] Quotas assigned to this region.

repeated .google.cloud.compute.v1.Quota quotas = 125341947;

Returns
Type Description
int

getQuotasList()

public List<Quota> getQuotasList()

[Output Only] Quotas assigned to this region.

repeated .google.cloud.compute.v1.Quota quotas = 125341947;

Returns
Type Description
List<Quota>

getQuotasOrBuilder(int index)

public QuotaOrBuilder getQuotasOrBuilder(int index)

[Output Only] Quotas assigned to this region.

repeated .google.cloud.compute.v1.Quota quotas = 125341947;

Parameter
Name Description
index int
Returns
Type Description
QuotaOrBuilder

getQuotasOrBuilderList()

public List<? extends QuotaOrBuilder> getQuotasOrBuilderList()

[Output Only] Quotas assigned to this region.

repeated .google.cloud.compute.v1.Quota quotas = 125341947;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.QuotaOrBuilder>
public String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public String getStatus()

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

optional string status = 181260274;

Returns
Type Description
String

The status.

getStatusBytes()

public ByteString getStatusBytes()

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

optional string status = 181260274;

Returns
Type Description
ByteString

The bytes for status.

getSupportsPzs()

public boolean getSupportsPzs()

[Output Only] Reserved for future use.

optional bool supports_pzs = 83983214;

Returns
Type Description
boolean

The supportsPzs.

getZones(int index)

public String getZones(int index)

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

repeated string zones = 116085319;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The zones at the given index.

getZonesBytes(int index)

public ByteString getZonesBytes(int index)

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

repeated string zones = 116085319;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the zones at the given index.

getZonesCount()

public int getZonesCount()

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

repeated string zones = 116085319;

Returns
Type Description
int

The count of zones.

getZonesList()

public ProtocolStringList getZonesList()

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

repeated string zones = 116085319;

Returns
Type Description
ProtocolStringList

A list containing the zones.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDeprecated()

public boolean hasDeprecated()

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

optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;

Returns
Type Description
boolean

Whether the deprecated field is set.

hasDescription()

public boolean hasDescription()

[Output Only] Textual description of the resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasId()

public boolean hasId()

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

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

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

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasName()

public boolean hasName()

[Output Only] Name of the resource.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasQuotaStatusWarning()

public boolean hasQuotaStatusWarning()

[Output Only] Warning of fetching the quotas field for this region. This field is populated only if fetching of the quotas field fails.

optional .google.cloud.compute.v1.QuotaStatusWarning quota_status_warning = 302941430;

Returns
Type Description
boolean

Whether the quotaStatusWarning field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasStatus()

public boolean hasStatus()

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

optional string status = 181260274;

Returns
Type Description
boolean

Whether the status field is set.

hasSupportsPzs()

public boolean hasSupportsPzs()

[Output Only] Reserved for future use.

optional bool supports_pzs = 83983214;

Returns
Type Description
boolean

Whether the supportsPzs field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Region.Builder newBuilderForType()
Returns
Type Description
Region.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Region.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Region.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Region.Builder toBuilder()
Returns
Type Description
Region.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException