target.apidocs.com.google.api.services.cloudkms.v1.CloudKMS.Projects.Locations.KeyRings.GetIamPolicy.html Maven / Gradle / Ivy
CloudKMS.Projects.Locations.KeyRings.GetIamPolicy (Cloud Key Management Service (KMS) API v1-rev20240801-2.0.0)
com.google.api.services.cloudkms.v1
Class CloudKMS.Projects.Locations.KeyRings.GetIamPolicy
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
-
- com.google.api.services.cloudkms.v1.CloudKMSRequest<Policy>
-
- com.google.api.services.cloudkms.v1.CloudKMS.Projects.Locations.KeyRings.GetIamPolicy
-
- Enclosing class:
- CloudKMS.Projects.Locations.KeyRings
public class CloudKMS.Projects.Locations.KeyRings.GetIamPolicy
extends CloudKMSRequest<Policy>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected GetIamPolicy(String resource)
Gets the access control policy for a resource.
-
Method Summary
-
Methods inherited from class com.google.api.services.cloudkms.v1.CloudKMSRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
-
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
-
GetIamPolicy
protected GetIamPolicy(String resource)
Gets the access control policy for a resource. Returns an empty policy if the resource exists
and does not have a policy set.
Create a request for the method "keyRings.getIamPolicy".
This request holds the parameters needed by the the cloudkms server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
operation. CloudKMS.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must be called to initialize this instance immediately after invoking the constructor.
- 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.- Since:
- 1.13
-
Method Detail
-
executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Policy>- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Policy>- Throws:
IOException
-
set$Xgafv
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy set$Xgafv(String $Xgafv)
Description copied from class: CloudKMSRequest
V1 error format.
- Overrides:
set$Xgafv in class CloudKMSRequest<Policy>
-
setAccessToken
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setAccessToken(String accessToken)
Description copied from class: CloudKMSRequest
OAuth access token.
- Overrides:
setAccessToken in class CloudKMSRequest<Policy>
-
setAlt
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setAlt(String alt)
Description copied from class: CloudKMSRequest
Data format for response.
- Overrides:
setAlt in class CloudKMSRequest<Policy>
-
setCallback
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setCallback(String callback)
Description copied from class: CloudKMSRequest
JSONP
- Overrides:
setCallback in class CloudKMSRequest<Policy>
-
setFields
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setFields(String fields)
Description copied from class: CloudKMSRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class CloudKMSRequest<Policy>
-
setKey
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setKey(String key)
Description copied from class: CloudKMSRequest
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.
- Overrides:
setKey in class CloudKMSRequest<Policy>
-
setOauthToken
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setOauthToken(String oauthToken)
Description copied from class: CloudKMSRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class CloudKMSRequest<Policy>
-
setPrettyPrint
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setPrettyPrint(Boolean prettyPrint)
Description copied from class: CloudKMSRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class CloudKMSRequest<Policy>
-
setQuotaUser
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setQuotaUser(String quotaUser)
Description copied from class: CloudKMSRequest
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.
- Overrides:
setQuotaUser in class CloudKMSRequest<Policy>
-
setUploadType
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setUploadType(String uploadType)
Description copied from class: CloudKMSRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class CloudKMSRequest<Policy>
-
setUploadProtocol
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setUploadProtocol(String uploadProtocol)
Description copied from class: CloudKMSRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class CloudKMSRequest<Policy>
-
getResource
public String getResource()
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.
-
setResource
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setResource(String 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.
-
getOptionsRequestedPolicyVersion
public Integer getOptionsRequestedPolicyVersion()
Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1,
and 3. Requests specifying an invalid value will be rejected. Requests for policies with any
conditional role bindings must specify version 3. Policies with no conditional role bindings may
specify any valid value or leave the field unset. The policy in the response might use the policy
version that you specified, or it might use a lower policy version. For example, if you specify
version 3, but the policy has no conditional role bindings, the response uses version 1. To learn
which resources support conditions in their IAM policies, see the [IAM
documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-
setOptionsRequestedPolicyVersion
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy setOptionsRequestedPolicyVersion(Integer optionsRequestedPolicyVersion)
Optional. The maximum policy version that will be used to format the policy. Valid
values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests
for policies with any conditional role bindings must specify version 3. Policies with
no conditional role bindings may specify any valid value or leave the field unset. The
policy in the response might use the policy version that you specified, or it might use
a lower policy version. For example, if you specify version 3, but the policy has no
conditional role bindings, the response uses version 1. To learn which resources
support conditions in their IAM policies, see the [IAM
documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-
set
public CloudKMS.Projects.Locations.KeyRings.GetIamPolicy set(String parameterName,
Object value)
- Overrides:
set in class CloudKMSRequest<Policy>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy