com.google.api.services.cloudresourcemanager.v3

Class CloudResourceManager.TagKeys

java.lang.Object

com.google.api.services.cloudresourcemanager.v3.CloudResourceManager.TagKeys

Enclosing class:

CloudResourceManager

public class CloudResourceManager.TagKeys
extends Object

The "tagKeys" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudResourceManager.TagKeys.Create
class	CloudResourceManager.TagKeys.Delete
class	CloudResourceManager.TagKeys.Get
class	CloudResourceManager.TagKeys.GetIamPolicy
class	CloudResourceManager.TagKeys.GetNamespaced
class	CloudResourceManager.TagKeys.List
class	CloudResourceManager.TagKeys.Patch
class	CloudResourceManager.TagKeys.SetIamPolicy
class	CloudResourceManager.TagKeys.TestIamPermissions

Constructor Summary

Constructors

Constructor and Description
TagKeys()

Method Summary

Modifier and Type	Method and Description
CloudResourceManager.TagKeys.Create	create(TagKey content) Creates a new TagKey.
CloudResourceManager.TagKeys.Delete	delete(String name) Deletes a TagKey.
CloudResourceManager.TagKeys.Get	get(String name) Retrieves a TagKey.
CloudResourceManager.TagKeys.GetIamPolicy	getIamPolicy(String resource, GetIamPolicyRequest content) Gets the access control policy for a TagKey.
CloudResourceManager.TagKeys.GetNamespaced	getNamespaced() Retrieves a TagKey by its namespaced name.
CloudResourceManager.TagKeys.List	list() Lists all TagKeys for a parent resource.
CloudResourceManager.TagKeys.Patch	patch(String name, TagKey content) Updates the attributes of the TagKey resource.
CloudResourceManager.TagKeys.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on a TagKey, replacing any existing policy.
CloudResourceManager.TagKeys.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified TagKey.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TagKeys

public TagKeys()

Method Detail

create

public CloudResourceManager.TagKeys.Create create(TagKey content)
                                           throws IOException

Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time. Create a request for the method "tagKeys.create". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the TagKey

Returns:

the request

Throws:

IOException

delete

public CloudResourceManager.TagKeys.Delete delete(String name)
                                           throws IOException

Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues. Create a request for the method "tagKeys.delete". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of a TagKey to be deleted in the format `tagKeys/123`. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully.

Returns:

the request

Throws:

IOException

get

public CloudResourceManager.TagKeys.Get get(String name)
                                     throws IOException

Retrieves a TagKey. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it. Create a request for the method "tagKeys.get". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. A resource name in the format `tagKeys/{id}`, such as `tagKeys/123`.

Returns:

the request

Throws:

IOException

getIamPolicy

public CloudResourceManager.TagKeys.GetIamPolicy getIamPolicy(String resource,
                                                              GetIamPolicyRequest content)
                                                       throws IOException

Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on the specified TagKey. Create a request for the method "tagKeys.getIamPolicy". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the GetIamPolicyRequest

Returns:

the request

Throws:

IOException

getNamespaced

public CloudResourceManager.TagKeys.GetNamespaced getNamespaced()
                                                         throws IOException

Retrieves a TagKey by its namespaced name. This method will return `PERMISSION_DENIED` if the key does not exist or the user does not have permission to view it. Create a request for the method "tagKeys.getNamespaced". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

list

public CloudResourceManager.TagKeys.List list()
                                       throws IOException

Lists all TagKeys for a parent resource. Create a request for the method "tagKeys.list". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

patch

public CloudResourceManager.TagKeys.Patch patch(String name,
                                                TagKey content)
                                         throws IOException

Updates the attributes of the TagKey resource. Create a request for the method "tagKeys.patch". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Immutable. The resource name for a TagKey. Must be in the format `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for the TagKey.

content - the TagKey

Returns:

the request

Throws:

IOException

setIamPolicy

public CloudResourceManager.TagKeys.SetIamPolicy setIamPolicy(String resource,
                                                              SetIamPolicyRequest content)
                                                       throws IOException

Sets the access control policy on a TagKey, replacing any existing policy. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `resourcemanager.tagKeys.setIamPolicy` permission on the identified tagValue. Create a request for the method "tagKeys.setIamPolicy". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public CloudResourceManager.TagKeys.TestIamPermissions testIamPermissions(String resource,
                                                                          TestIamPermissionsRequest content)
                                                                   throws IOException

Returns permissions that a caller has on the specified TagKey. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". There are no permissions required for making this API call. Create a request for the method "tagKeys.testIamPermissions". This request holds the parameters needed by the cloudresourcemanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException