target.apidocs.com.google.api.services.pubsub.Pubsub.Projects.Schemas.GetIamPolicy.html Maven / Gradle / Ivy
Pubsub.Projects.Schemas.GetIamPolicy (Cloud Pub/Sub API v1-rev20240918-2.0.0)
com.google.api.services.pubsub
Class Pubsub.Projects.Schemas.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.pubsub.PubsubRequest<Policy>
-
- com.google.api.services.pubsub.Pubsub.Projects.Schemas.GetIamPolicy
-
- Enclosing class:
- Pubsub.Projects.Schemas
public class Pubsub.Projects.Schemas.GetIamPolicy
extends PubsubRequest<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.pubsub.PubsubRequest
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 "schemas.getIamPolicy".
This request holds the parameters needed by the the pubsub server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
Pubsub.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 Pubsub.Projects.Schemas.GetIamPolicy set$Xgafv(String $Xgafv)
Description copied from class: PubsubRequest
V1 error format.
- Overrides:
set$Xgafv in class PubsubRequest<Policy>
-
setAccessToken
public Pubsub.Projects.Schemas.GetIamPolicy setAccessToken(String accessToken)
Description copied from class: PubsubRequest
OAuth access token.
- Overrides:
setAccessToken in class PubsubRequest<Policy>
-
setAlt
public Pubsub.Projects.Schemas.GetIamPolicy setAlt(String alt)
Description copied from class: PubsubRequest
Data format for response.
- Overrides:
setAlt in class PubsubRequest<Policy>
-
setCallback
public Pubsub.Projects.Schemas.GetIamPolicy setCallback(String callback)
Description copied from class: PubsubRequest
JSONP
- Overrides:
setCallback in class PubsubRequest<Policy>
-
setFields
public Pubsub.Projects.Schemas.GetIamPolicy setFields(String fields)
Description copied from class: PubsubRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class PubsubRequest<Policy>
-
setKey
public Pubsub.Projects.Schemas.GetIamPolicy setKey(String key)
Description copied from class: PubsubRequest
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 PubsubRequest<Policy>
-
setOauthToken
public Pubsub.Projects.Schemas.GetIamPolicy setOauthToken(String oauthToken)
Description copied from class: PubsubRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class PubsubRequest<Policy>
-
setPrettyPrint
public Pubsub.Projects.Schemas.GetIamPolicy setPrettyPrint(Boolean prettyPrint)
Description copied from class: PubsubRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class PubsubRequest<Policy>
-
setQuotaUser
public Pubsub.Projects.Schemas.GetIamPolicy setQuotaUser(String quotaUser)
Description copied from class: PubsubRequest
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 PubsubRequest<Policy>
-
setUploadType
public Pubsub.Projects.Schemas.GetIamPolicy setUploadType(String uploadType)
Description copied from class: PubsubRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class PubsubRequest<Policy>
-
setUploadProtocol
public Pubsub.Projects.Schemas.GetIamPolicy setUploadProtocol(String uploadProtocol)
Description copied from class: PubsubRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class PubsubRequest<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 Pubsub.Projects.Schemas.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 Pubsub.Projects.Schemas.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 Pubsub.Projects.Schemas.GetIamPolicy set(String parameterName,
Object value)
- Overrides:
set in class PubsubRequest<Policy>
Copyright © 2011–2024 Google. All rights reserved.