Storage.Buckets.TestIamPermissions (Cloud Storage JSON API v1-rev20220705-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<TestIamPermissionsResponse>
        
        com.google.api.services.storage.Storage.Buckets.TestIamPermissions

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Storage.Buckets

public class Storage.Buckets.TestIamPermissions
extends StorageRequest<TestIamPermissionsResponse>

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  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`	`TestIamPermissions(String bucket, List<String> permissions)` Tests a set of permissions on the given bucket to see which, if any, are held by the caller.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeUsingHead()`
`String`	`getBucket()` Name of a bucket.
`List<String>`	`getPermissions()` Permissions to test.
`String`	`getUserProject()` The project to be billed for this request.
`Storage.Buckets.TestIamPermissions`	`set(String parameterName, Object value)`
`Storage.Buckets.TestIamPermissions`	`setAlt(String alt)` Data format for the response.
`Storage.Buckets.TestIamPermissions`	`setBucket(String bucket)` Name of a bucket.
`Storage.Buckets.TestIamPermissions`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Storage.Buckets.TestIamPermissions`	`setKey(String key)` API key.
`Storage.Buckets.TestIamPermissions`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Storage.Buckets.TestIamPermissions`	`setPermissions(List<String> permissions)` Permissions to test.
`Storage.Buckets.TestIamPermissions`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Storage.Buckets.TestIamPermissions`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Storage.Buckets.TestIamPermissions`	`setUploadType(String uploadType)` Upload protocol for media (e.g.
`Storage.Buckets.TestIamPermissions`	`setUserIp(String userIp)` Deprecated.
`Storage.Buckets.TestIamPermissions`	`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.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
  - TestIamPermissions
```
protected TestIamPermissions(String bucket,
                             List<String> permissions)
```
    Tests a set of permissions on the given bucket to see which, if any, are held by the caller. Create a request for the method "buckets.testIamPermissions". 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.
    TestIamPermissions#initialize(com.google.api.client.googleapis.services.A bstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    bucket - Name of a bucket.
    
    permissions - Permissions to test.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public HttpResponse executeUsingHead()
                              throws IOException
```
    Overrides:
    
    executeUsingHead in class AbstractGoogleClientRequest<TestIamPermissionsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class AbstractGoogleClientRequest<TestIamPermissionsResponse>
    
    Throws:
    
    IOException
  - setAlt
```
public Storage.Buckets.TestIamPermissions setAlt(String alt)
```
    Description copied from class: StorageRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class StorageRequest<TestIamPermissionsResponse>
  - setFields
```
public Storage.Buckets.TestIamPermissions setFields(String fields)
```
    Description copied from class: StorageRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class StorageRequest<TestIamPermissionsResponse>
  - setKey
```
public Storage.Buckets.TestIamPermissions 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<TestIamPermissionsResponse>
  - setOauthToken
```
public Storage.Buckets.TestIamPermissions setOauthToken(String oauthToken)
```
    Description copied from class: StorageRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class StorageRequest<TestIamPermissionsResponse>
  - setPrettyPrint
```
public Storage.Buckets.TestIamPermissions setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: StorageRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class StorageRequest<TestIamPermissionsResponse>
  - setQuotaUser
```
public Storage.Buckets.TestIamPermissions 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<TestIamPermissionsResponse>
  - setUploadType
```
public Storage.Buckets.TestIamPermissions setUploadType(String uploadType)
```
    Description copied from class: StorageRequest
    
    Upload protocol for media (e.g. "media", "multipart", "resumable").
    
    Overrides:
    
    setUploadType in class StorageRequest<TestIamPermissionsResponse>
  - setUserIp
```
public Storage.Buckets.TestIamPermissions setUserIp(String userIp)
```
    Description copied from class: StorageRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class StorageRequest<TestIamPermissionsResponse>
  - getBucket
```
public String getBucket()
```
    Name of a bucket.
  - setBucket
```
public Storage.Buckets.TestIamPermissions setBucket(String bucket)
```
    Name of a bucket.
  - getPermissions
```
public List<String> getPermissions()
```
    Permissions to test.
  - setPermissions
```
public Storage.Buckets.TestIamPermissions setPermissions(List<String> permissions)
```
    Permissions to test.
  - getUserProject
```
public String getUserProject()
```
    The project to be billed for this request. Required for Requester Pays buckets.
  - setUserProject
```
public Storage.Buckets.TestIamPermissions setUserProject(String userProject)
```
    The project to be billed for this request. Required for Requester Pays buckets.
  - set
```
public Storage.Buckets.TestIamPermissions set(String parameterName,
                                              Object value)
```
    Overrides:
    
    set in class StorageRequest<TestIamPermissionsResponse>

Class Storage.Buckets.TestIamPermissions

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

TestIamPermissions

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUserIp

getBucket

setBucket

getPermissions

setPermissions

getUserProject

setUserProject

set