com.google.api.services.servicecontrol.v2.model

Class Resource

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.servicecontrol.v2.model.Resource

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Resource
extends com.google.api.client.json.GenericJson

This message defines core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a file stored on a network storage service.

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 Service Control API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Resource()

Method Summary

Modifier and Type	Method and Description
Resource	clone()
Map<String,String>	getAnnotations() Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
String	getCreateTime() Output only.
String	getDeleteTime() Output only.
String	getDisplayName() Mutable.
String	getEtag() Output only.
Map<String,String>	getLabels() The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.
String	getLocation() Immutable.
String	getName() The stable identifier (name) of a resource on the `service`.
String	getService() The name of the service that this resource belongs to, such as `pubsub.googleapis.com`.
String	getType() The type of the resource.
String	getUid() The unique identifier of the resource.
String	getUpdateTime() Output only.
Resource	set(String fieldName, Object value)
Resource	setAnnotations(Map<String,String> annotations) Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
Resource	setCreateTime(String createTime) Output only.
Resource	setDeleteTime(String deleteTime) Output only.
Resource	setDisplayName(String displayName) Mutable.
Resource	setEtag(String etag) Output only.
Resource	setLabels(Map<String,String> labels) The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.
Resource	setLocation(String location) Immutable.
Resource	setName(String name) The stable identifier (name) of a resource on the `service`.
Resource	setService(String service) The name of the service that this resource belongs to, such as `pubsub.googleapis.com`.
Resource	setType(String type) The type of the resource.
Resource	setUid(String uid) The unique identifier of the resource.
Resource	setUpdateTime(String updateTime) Output only.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Resource

public Resource()

Method Detail

getAnnotations

public Map<String,String> getAnnotations()

Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with- objects/annotations/

Returns:

value or null for none

setAnnotations

public Resource setAnnotations(Map<String,String> annotations)

Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with- objects/annotations/

Parameters:

annotations - annotations or null for none

getCreateTime

public String getCreateTime()

Output only. The timestamp when the resource was created. This may be either the time creation was initiated or when it was completed.

Returns:

value or null for none

setCreateTime

public Resource setCreateTime(String createTime)

Output only. The timestamp when the resource was created. This may be either the time creation was initiated or when it was completed.

Parameters:

createTime - createTime or null for none

getDeleteTime

public String getDeleteTime()

Output only. The timestamp when the resource was deleted. If the resource is not deleted, this must be empty.

Returns:

value or null for none

setDeleteTime

public Resource setDeleteTime(String deleteTime)

Output only. The timestamp when the resource was deleted. If the resource is not deleted, this must be empty.

Parameters:

deleteTime - deleteTime or null for none

getDisplayName

public String getDisplayName()

Mutable. The display name set by clients. Must be <= 63 characters.

Returns:

value or null for none

setDisplayName

public Resource setDisplayName(String displayName)

Mutable. The display name set by clients. Must be <= 63 characters.

Parameters:

displayName - displayName or null for none

getEtag

public String getEtag()

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

Returns:

value or null for none

setEtag

public Resource setEtag(String etag)

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

Parameters:

etag - etag or null for none

getLabels

public Map<String,String> getLabels()

The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.

Returns:

value or null for none

setLabels

public Resource setLabels(Map<String,String> labels)

The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.

Parameters:

labels - labels or null for none

getLocation

public String getLocation()

Immutable. The location of the resource. The location encoding is specific to the service provider, and new encoding may be introduced as the service evolves. For Google Cloud products, the encoding is what is used by Google Cloud APIs, such as `us-east1`, `aws-us-east-1`, and `azure-eastus2`. The semantics of `location` is identical to the `cloud.googleapis.com/location` label used by some Google Cloud APIs.

Returns:

value or null for none

setLocation

public Resource setLocation(String location)

Immutable. The location of the resource. The location encoding is specific to the service provider, and new encoding may be introduced as the service evolves. For Google Cloud products, the encoding is what is used by Google Cloud APIs, such as `us-east1`, `aws-us-east-1`, and `azure-eastus2`. The semantics of `location` is identical to the `cloud.googleapis.com/location` label used by some Google Cloud APIs.

Parameters:

location - location or null for none

getName

public String getName()

The stable identifier (name) of a resource on the `service`. A resource can be logically identified as "//{resource.service}/{resource.name}". The differences between a resource name and a URI are: * Resource name is a logical identifier, independent of network protocol and API version. For example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * URI often includes protocol and version information, so it can be used directly by applications. For example, `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See https://cloud.google.com/apis/design/resource_names for details.

Returns:

value or null for none

setName

public Resource setName(String name)

The stable identifier (name) of a resource on the `service`. A resource can be logically identified as "//{resource.service}/{resource.name}". The differences between a resource name and a URI are: * Resource name is a logical identifier, independent of network protocol and API version. For example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * URI often includes protocol and version information, so it can be used directly by applications. For example, `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See https://cloud.google.com/apis/design/resource_names for details.

Parameters:

name - name or null for none

getService

public String getService()

The name of the service that this resource belongs to, such as `pubsub.googleapis.com`. The service may be different from the DNS hostname that actually serves the request.

Returns:

value or null for none

setService

public Resource setService(String service)

The name of the service that this resource belongs to, such as `pubsub.googleapis.com`. The service may be different from the DNS hostname that actually serves the request.

Parameters:

service - service or null for none

getType

public String getType()

The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be "{service}/{kind}", such as "pubsub.googleapis.com/Topic".

Returns:

value or null for none

setType

public Resource setType(String type)

The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be "{service}/{kind}", such as "pubsub.googleapis.com/Topic".

Parameters:

type - type or null for none

getUid

public String getUid()

The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

Returns:

value or null for none

setUid

public Resource setUid(String uid)

The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

Parameters:

uid - uid or null for none

getUpdateTime

public String getUpdateTime()

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

Returns:

value or null for none

setUpdateTime

public Resource setUpdateTime(String updateTime)

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

Parameters:

updateTime - updateTime or null for none

set

public Resource set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Resource clone()

Overrides:

clone in class com.google.api.client.json.GenericJson