com.google.api.services.compute.model.Region Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.compute.model;
/**
* Represents a Region resource. A region is a geographical area where a resource is located. For
* more information, read Regions and Zones.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class Region extends com.google.api.client.json.GenericJson {
/**
* [Output Only] Creation timestamp in RFC3339 text format.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String creationTimestamp;
/**
* [Output Only] The deprecation status associated with this region.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private DeprecationStatus deprecated;
/**
* [Output Only] Textual description of the resource.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String description;
/**
* [Output Only] The unique identifier for the resource. This identifier is defined by the server.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.math.BigInteger id;
/**
* [Output Only] Type of the resource. Always compute#region for regions.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String kind;
/**
* [Output Only] Name of the resource.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* [Output Only] Warning of fetching the `quotas` field for this region. This field is populated
* only if fetching of the `quotas` field fails.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private QuotaStatusWarning quotaStatusWarning;
/**
* [Output Only] Quotas assigned to this region.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List quotas;
static {
// hack to force ProGuard to consider Quota used, since otherwise it would be stripped out
// see https://github.com/google/google-api-java-client/issues/543
com.google.api.client.util.Data.nullOf(Quota.class);
}
/**
* [Output Only] Server-defined URL for the resource.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String selfLink;
/**
* [Output Only] Status of the region, either UP or DOWN.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String status;
/**
* [Output Only] Reserved for future use.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean supportsPzs;
/**
* [Output Only] A list of zones available in this region, in the form of resource URLs.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List zones;
/**
* [Output Only] Creation timestamp in RFC3339 text format.
* @return value or {@code null} for none
*/
public java.lang.String getCreationTimestamp() {
return creationTimestamp;
}
/**
* [Output Only] Creation timestamp in RFC3339 text format.
* @param creationTimestamp creationTimestamp or {@code null} for none
*/
public Region setCreationTimestamp(java.lang.String creationTimestamp) {
this.creationTimestamp = creationTimestamp;
return this;
}
/**
* [Output Only] The deprecation status associated with this region.
* @return value or {@code null} for none
*/
public DeprecationStatus getDeprecated() {
return deprecated;
}
/**
* [Output Only] The deprecation status associated with this region.
* @param deprecated deprecated or {@code null} for none
*/
public Region setDeprecated(DeprecationStatus deprecated) {
this.deprecated = deprecated;
return this;
}
/**
* [Output Only] Textual description of the resource.
* @return value or {@code null} for none
*/
public java.lang.String getDescription() {
return description;
}
/**
* [Output Only] Textual description of the resource.
* @param description description or {@code null} for none
*/
public Region setDescription(java.lang.String description) {
this.description = description;
return this;
}
/**
* [Output Only] The unique identifier for the resource. This identifier is defined by the server.
* @return value or {@code null} for none
*/
public java.math.BigInteger getId() {
return id;
}
/**
* [Output Only] The unique identifier for the resource. This identifier is defined by the server.
* @param id id or {@code null} for none
*/
public Region setId(java.math.BigInteger id) {
this.id = id;
return this;
}
/**
* [Output Only] Type of the resource. Always compute#region for regions.
* @return value or {@code null} for none
*/
public java.lang.String getKind() {
return kind;
}
/**
* [Output Only] Type of the resource. Always compute#region for regions.
* @param kind kind or {@code null} for none
*/
public Region setKind(java.lang.String kind) {
this.kind = kind;
return this;
}
/**
* [Output Only] Name of the resource.
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* [Output Only] Name of the resource.
* @param name name or {@code null} for none
*/
public Region setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* [Output Only] Warning of fetching the `quotas` field for this region. This field is populated
* only if fetching of the `quotas` field fails.
* @return value or {@code null} for none
*/
public QuotaStatusWarning getQuotaStatusWarning() {
return quotaStatusWarning;
}
/**
* [Output Only] Warning of fetching the `quotas` field for this region. This field is populated
* only if fetching of the `quotas` field fails.
* @param quotaStatusWarning quotaStatusWarning or {@code null} for none
*/
public Region setQuotaStatusWarning(QuotaStatusWarning quotaStatusWarning) {
this.quotaStatusWarning = quotaStatusWarning;
return this;
}
/**
* [Output Only] Quotas assigned to this region.
* @return value or {@code null} for none
*/
public java.util.List getQuotas() {
return quotas;
}
/**
* [Output Only] Quotas assigned to this region.
* @param quotas quotas or {@code null} for none
*/
public Region setQuotas(java.util.List quotas) {
this.quotas = quotas;
return this;
}
/**
* [Output Only] Server-defined URL for the resource.
* @return value or {@code null} for none
*/
public java.lang.String getSelfLink() {
return selfLink;
}
/**
* [Output Only] Server-defined URL for the resource.
* @param selfLink selfLink or {@code null} for none
*/
public Region setSelfLink(java.lang.String selfLink) {
this.selfLink = selfLink;
return this;
}
/**
* [Output Only] Status of the region, either UP or DOWN.
* @return value or {@code null} for none
*/
public java.lang.String getStatus() {
return status;
}
/**
* [Output Only] Status of the region, either UP or DOWN.
* @param status status or {@code null} for none
*/
public Region setStatus(java.lang.String status) {
this.status = status;
return this;
}
/**
* [Output Only] Reserved for future use.
* @return value or {@code null} for none
*/
public java.lang.Boolean getSupportsPzs() {
return supportsPzs;
}
/**
* [Output Only] Reserved for future use.
* @param supportsPzs supportsPzs or {@code null} for none
*/
public Region setSupportsPzs(java.lang.Boolean supportsPzs) {
this.supportsPzs = supportsPzs;
return this;
}
/**
* [Output Only] A list of zones available in this region, in the form of resource URLs.
* @return value or {@code null} for none
*/
public java.util.List getZones() {
return zones;
}
/**
* [Output Only] A list of zones available in this region, in the form of resource URLs.
* @param zones zones or {@code null} for none
*/
public Region setZones(java.util.List zones) {
this.zones = zones;
return this;
}
@Override
public Region set(String fieldName, Object value) {
return (Region) super.set(fieldName, value);
}
@Override
public Region clone() {
return (Region) super.clone();
}
/**
* [Output Only] Warning of fetching the `quotas` field for this region. This field is populated
* only if fetching of the `quotas` field fails.
*/
public static final class QuotaStatusWarning extends com.google.api.client.json.GenericJson {
/**
* [Output Only] A warning code, if applicable. For example, Compute Engine returns
* NO_RESULTS_ON_PAGE if there are no results in the response.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String code;
/**
* [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key":
* "scope", "value": "zones/us-east1-d" }
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List data;
static {
// hack to force ProGuard to consider Data used, since otherwise it would be stripped out
// see https://github.com/google/google-api-java-client/issues/543
com.google.api.client.util.Data.nullOf(Data.class);
}
/**
* [Output Only] A human-readable description of the warning code.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String message;
/**
* [Output Only] A warning code, if applicable. For example, Compute Engine returns
* NO_RESULTS_ON_PAGE if there are no results in the response.
* @return value or {@code null} for none
*/
public java.lang.String getCode() {
return code;
}
/**
* [Output Only] A warning code, if applicable. For example, Compute Engine returns
* NO_RESULTS_ON_PAGE if there are no results in the response.
* @param code code or {@code null} for none
*/
public QuotaStatusWarning setCode(java.lang.String code) {
this.code = code;
return this;
}
/**
* [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key":
* "scope", "value": "zones/us-east1-d" }
* @return value or {@code null} for none
*/
public java.util.List getData() {
return data;
}
/**
* [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key":
* "scope", "value": "zones/us-east1-d" }
* @param data data or {@code null} for none
*/
public QuotaStatusWarning setData(java.util.List data) {
this.data = data;
return this;
}
/**
* [Output Only] A human-readable description of the warning code.
* @return value or {@code null} for none
*/
public java.lang.String getMessage() {
return message;
}
/**
* [Output Only] A human-readable description of the warning code.
* @param message message or {@code null} for none
*/
public QuotaStatusWarning setMessage(java.lang.String message) {
this.message = message;
return this;
}
@Override
public QuotaStatusWarning set(String fieldName, Object value) {
return (QuotaStatusWarning) super.set(fieldName, value);
}
@Override
public QuotaStatusWarning clone() {
return (QuotaStatusWarning) super.clone();
}
/**
* Model definition for RegionQuotaStatusWarningData.
*/
public static final class Data extends com.google.api.client.json.GenericJson {
/**
* [Output Only] A key that provides more detail on the warning being returned. For example, for
* warnings where there are no results in a list request for a particular zone, this key might be
* scope and the key value might be the zone name. Other examples might be a key indicating a
* deprecated resource and a suggested replacement, or a warning about invalid network settings
* (for example, if an instance attempts to perform IP forwarding but is not enabled for IP
* forwarding).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String key;
/**
* [Output Only] A warning data value corresponding to the key.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String value;
/**
* [Output Only] A key that provides more detail on the warning being returned. For example, for
* warnings where there are no results in a list request for a particular zone, this key might be
* scope and the key value might be the zone name. Other examples might be a key indicating a
* deprecated resource and a suggested replacement, or a warning about invalid network settings
* (for example, if an instance attempts to perform IP forwarding but is not enabled for IP
* forwarding).
* @return value or {@code null} for none
*/
public java.lang.String getKey() {
return key;
}
/**
* [Output Only] A key that provides more detail on the warning being returned. For example, for
* warnings where there are no results in a list request for a particular zone, this key might be
* scope and the key value might be the zone name. Other examples might be a key indicating a
* deprecated resource and a suggested replacement, or a warning about invalid network settings
* (for example, if an instance attempts to perform IP forwarding but is not enabled for IP
* forwarding).
* @param key key or {@code null} for none
*/
public Data setKey(java.lang.String key) {
this.key = key;
return this;
}
/**
* [Output Only] A warning data value corresponding to the key.
* @return value or {@code null} for none
*/
public java.lang.String getValue() {
return value;
}
/**
* [Output Only] A warning data value corresponding to the key.
* @param value value or {@code null} for none
*/
public Data setValue(java.lang.String value) {
this.value = value;
return this;
}
@Override
public Data set(String fieldName, Object value) {
return (Data) super.set(fieldName, value);
}
@Override
public Data clone() {
return (Data) super.clone();
}
}
}
}