View Source GoogleApi.KMSInventory.V1.Api.Organizations (google_api_kms_inventory v0.4.0)
API calls for all endpoints tagged Organizations
.
Summary
Functions
Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.
Functions
Link to this function
kmsinventory_organizations_protected_resources_search(connection, scope, optional_params \\ [], opts \\ [])
View Source@spec kmsinventory_organizations_protected_resources_search( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.KMSInventory.V1.Model.GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization.
Parameters
-
connection
(type:GoogleApi.KMSInventory.V1.Connection.t
) - Connection to server -
scope
(type:String.t
) - Required. Resource name of the organization. Example: organizations/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"). -
:cryptoKey
(type:String.t
) - Required. The resource name of the CryptoKey. -
:pageSize
(type:integer()
) - The maximum number of resources to return. The service may return fewer than this value. If unspecified, at most 500 resources will be returned. The maximum value is 500; values above 500 will be coerced to 500. -
:pageToken
(type:String.t
) - A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token. -
:resourceTypes
(type:list(String.t)
) - Optional. A list of resource types that this request searches for. If empty, it will search all the trackable resource types. Regular expressions are also supported. For example: `compute.googleapis.com.snapshots resources whose type starts with
compute.googleapis.com. *
.Imagesnapshots resources whose type ends with
Image`..*Image.*
snapshots resources whose type containsImage
. See RE2 for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.KMSInventory.V1.Model.GoogleCloudKmsInventoryV1SearchProtectedResourcesResponse{}}
on success -
{:error, info}
on failure