Show / Hide Table of Contents

Class TagKeysResource

The "tagKeys" collection of methods.

Inheritance
object
TagKeysResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudResourceManager.v3
Assembly: Google.Apis.CloudResourceManager.v3.dll
Syntax
public class TagKeysResource

Constructors

TagKeysResource(IClientService)

Constructs a new resource.

Declaration
public TagKeysResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(TagKey)

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.

Declaration
public virtual TagKeysResource.CreateRequest Create(TagKey body)
Parameters
Type Name Description
TagKey body

The body of the request.

Returns
Type Description
TagKeysResource.CreateRequest

Delete(string)

Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.

Declaration
public virtual TagKeysResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string 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
Type Description
TagKeysResource.DeleteRequest

Get(string)

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.

Declaration
public virtual TagKeysResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
TagKeysResource.GetRequest

GetIamPolicy(GetIamPolicyRequest, string)

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.

Declaration
public virtual TagKeysResource.GetIamPolicyRequest GetIamPolicy(GetIamPolicyRequest body, string resource)
Parameters
Type Name Description
GetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
TagKeysResource.GetIamPolicyRequest

GetNamespaced()

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.

Declaration
public virtual TagKeysResource.GetNamespacedRequest GetNamespaced()
Returns
Type Description
TagKeysResource.GetNamespacedRequest

List()

Lists all TagKeys for a parent resource.

Declaration
public virtual TagKeysResource.ListRequest List()
Returns
Type Description
TagKeysResource.ListRequest

Patch(TagKey, string)

Updates the attributes of the TagKey resource.

Declaration
public virtual TagKeysResource.PatchRequest Patch(TagKey body, string name)
Parameters
Type Name Description
TagKey body

The body of the request.

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

Returns
Type Description
TagKeysResource.PatchRequest

SetIamPolicy(SetIamPolicyRequest, string)

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.

Declaration
public virtual TagKeysResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
TagKeysResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

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.

Declaration
public virtual TagKeysResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
TagKeysResource.TestIamPermissionsRequest
In this article
Back to top Generated by DocFX