Storage.Buckets.GetIamPolicy (Cloud Storage JSON API v1-rev20240209-2.0.0)

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.storage.StorageRequest<Policy>
        
        com.google.api.services.storage.Storage.Buckets.GetIamPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Buckets
```
public class Storage.Buckets.GetIamPolicy
extends StorageRequest<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>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected GetIamPolicy(String bucket)
Returns an IAM policy for the specified bucket.

Constructors
Modifier	Constructor and Description
`protected`	`GetIamPolicy(String bucket)` Returns an IAM policy for the specified bucket.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`String`	`getBucket()` Name of a bucket.
`Integer`	`getOptionsRequestedPolicyVersion()` The IAM policy format version to be returned.
`String`	`getUserProject()` The project to be billed for this request.
`Storage.Buckets.GetIamPolicy`	`set(String parameterName, Object value)`
`Storage.Buckets.GetIamPolicy`	`setAlt(String alt)` Data format for the response.
`Storage.Buckets.GetIamPolicy`	`setBucket(String bucket)` Name of a bucket.
`Storage.Buckets.GetIamPolicy`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Storage.Buckets.GetIamPolicy`	`setKey(String key)` API key.
`Storage.Buckets.GetIamPolicy`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Storage.Buckets.GetIamPolicy`	`setOptionsRequestedPolicyVersion(Integer optionsRequestedPolicyVersion)` The IAM policy format version to be returned.
`Storage.Buckets.GetIamPolicy`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Storage.Buckets.GetIamPolicy`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Storage.Buckets.GetIamPolicy`	`setUploadType(String uploadType)` Upload protocol for media (e.g.
`Storage.Buckets.GetIamPolicy`	`setUserIp(String userIp)` Deprecated.
`Storage.Buckets.GetIamPolicy`	`setUserProject(String userProject)` The project to be billed for this request.

Methods inherited from class com.google.api.services.storage.StorageRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadType, getUserIp, 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 bucket)
```
    Returns an IAM policy for the specified bucket. Create a request for the method "buckets.getIamPolicy". This request holds the parameters needed by the the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Storage.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    bucket - Name of a bucket.
    
    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
  - setAlt
```
public Storage.Buckets.GetIamPolicy setAlt(String alt)
```
    Description copied from class: StorageRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class StorageRequest<Policy>
  - setFields
```
public Storage.Buckets.GetIamPolicy setFields(String fields)
```
    Description copied from class: StorageRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class StorageRequest<Policy>
  - setKey
```
public Storage.Buckets.GetIamPolicy setKey(String key)
```
    Description copied from class: StorageRequest
    
    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 StorageRequest<Policy>
  - setOauthToken
```
public Storage.Buckets.GetIamPolicy setOauthToken(String oauthToken)
```
    Description copied from class: StorageRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class StorageRequest<Policy>
  - setPrettyPrint
```
public Storage.Buckets.GetIamPolicy setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: StorageRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class StorageRequest<Policy>
  - setQuotaUser
```
public Storage.Buckets.GetIamPolicy setQuotaUser(String quotaUser)
```
    Description copied from class: StorageRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class StorageRequest<Policy>
  - setUploadType
```
public Storage.Buckets.GetIamPolicy setUploadType(String uploadType)
```
    Description copied from class: StorageRequest
    
    Upload protocol for media (e.g. "media", "multipart", "resumable").
    
    Overrides:
    
    setUploadType in class StorageRequest<Policy>
  - setUserIp
```
public Storage.Buckets.GetIamPolicy setUserIp(String userIp)
```
    Description copied from class: StorageRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class StorageRequest<Policy>
  - getBucket
```
public String getBucket()
```
    Name of a bucket.
  - setBucket
```
public Storage.Buckets.GetIamPolicy setBucket(String bucket)
```
    Name of a bucket.
  - getOptionsRequestedPolicyVersion
```
public Integer getOptionsRequestedPolicyVersion()
```
    The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails. [minimum: 1]
  - setOptionsRequestedPolicyVersion
```
public Storage.Buckets.GetIamPolicy setOptionsRequestedPolicyVersion(Integer optionsRequestedPolicyVersion)
```
    The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.
  - getUserProject
```
public String getUserProject()
```
    The project to be billed for this request. Required for Requester Pays buckets.
  - setUserProject
```
public Storage.Buckets.GetIamPolicy setUserProject(String userProject)
```
    The project to be billed for this request. Required for Requester Pays buckets.
  - set
```
public Storage.Buckets.GetIamPolicy set(String parameterName,
                                        Object value)
```
    Overrides:
    
    set in class StorageRequest<Policy>

Class Storage.Buckets.GetIamPolicy

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.storage.StorageRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GetIamPolicy

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUserIp

getBucket

setBucket

getOptionsRequestedPolicyVersion

setOptionsRequestedPolicyVersion

getUserProject

setUserProject

set