View Source GoogleApi.CloudResourceManager.V3.Api.TagKeys (google_api_cloud_resource_manager v0.44.0)
API calls for all endpoints tagged TagKeys
.
Summary
Functions
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.
Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.
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.
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.
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.
Lists all TagKeys for a parent resource.
Updates the attributes of the TagKey resource.
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.
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.
Functions
cloudresourcemanager_tag_keys_create(connection, optional_params \\ [], opts \\ [])
View Source@spec cloudresourcemanager_tag_keys_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.CloudResourceManager.V3.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V3.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:validateOnly
(type:boolean()
) - Optional. Set to true to perform validations necessary for creating the resource, but not actually perform the action. -
:body
(type:GoogleApi.CloudResourceManager.V3.Model.TagKey.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V3.Model.Operation{}}
on success -
{:error, info}
on failure
cloudresourcemanager_tag_keys_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudresourcemanager_tag_keys_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V3.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of a TagKey to be deleted in the formattagKeys/123
. The TagKey cannot be a parent of any existing TagValues or it will not be deleted successfully. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:etag
(type:String.t
) - Optional. The etag known to the client for the expected state of the TagKey. This is to be used for optimistic concurrency. -
:validateOnly
(type:boolean()
) - Optional. Set as true to perform validations necessary for deletion, but not actually perform the action.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V3.Model.Operation{}}
on success -
{:error, info}
on failure
cloudresourcemanager_tag_keys_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudresourcemanager_tag_keys_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V3.Model.TagKey.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. A resource name in the formattagKeys/{id}
, such astagKeys/123
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V3.Model.TagKey{}}
on success -
{:error, info}
on failure
cloudresourcemanager_tag_keys_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec cloudresourcemanager_tag_keys_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V3.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V3.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudResourceManager.V3.Model.GetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V3.Model.Policy{}}
on success -
{:error, info}
on failure
cloudresourcemanager_tag_keys_get_namespaced(connection, optional_params \\ [], opts \\ [])
View Source@spec cloudresourcemanager_tag_keys_get_namespaced( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V3.Model.TagKey.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V3.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:name
(type:String.t
) - Required. A namespaced tag key name in the format{parentId}/{tagKeyShort}
, such as42/foo
for a key with short name "foo" under the organization with ID 42 orr2-d2/bar
for a key with short name "bar" under the projectr2-d2
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V3.Model.TagKey{}}
on success -
{:error, info}
on failure
cloudresourcemanager_tag_keys_list(connection, optional_params \\ [], opts \\ [])
View Source@spec cloudresourcemanager_tag_keys_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.CloudResourceManager.V3.Model.ListTagKeysResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all TagKeys for a parent resource.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V3.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - Optional. The maximum number of TagKeys to return in the response. The server allows a maximum of 300 TagKeys to return. If unspecified, the server will use 100 as the default. -
:pageToken
(type:String.t
) - Optional. A pagination token returned from a previous call toListTagKey
that indicates where this listing should continue from. -
:parent
(type:String.t
) - Required. The resource name of the TagKey's parent. Must be of the formorganizations/{org_id}
orprojects/{project_id}
orprojects/{project_number}
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V3.Model.ListTagKeysResponse{}}
on success -
{:error, info}
on failure
cloudresourcemanager_tag_keys_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudresourcemanager_tag_keys_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V3.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the attributes of the TagKey resource.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V3.Connection.t
) - Connection to server -
name
(type:String.t
) - Immutable. The resource name for a TagKey. Must be in the formattagKeys/{tag_key_id}
, wheretag_key_id
is the generated numeric id for the TagKey. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Fields to be updated. The mask may only containdescription
oretag
. If omitted entirely, bothdescription
andetag
are assumed to be significant. -
:validateOnly
(type:boolean()
) - Set as true to perform validations necessary for updating the resource, but not actually perform the action. -
:body
(type:GoogleApi.CloudResourceManager.V3.Model.TagKey.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V3.Model.Operation{}}
on success -
{:error, info}
on failure
cloudresourcemanager_tag_keys_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec cloudresourcemanager_tag_keys_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V3.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V3.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudResourceManager.V3.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V3.Model.Policy{}}
on success -
{:error, info}
on failure
cloudresourcemanager_tag_keys_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])
View Source@spec cloudresourcemanager_tag_keys_test_iam_permissions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudResourceManager.V3.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.CloudResourceManager.V3.Connection.t
) - Connection to server -
resource
(type:String.t
) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudResourceManager.V3.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudResourceManager.V3.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure