Storage.Objects.TestIamPermissions (Cloud Storage JSON API v1 (Rev. 171) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.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.Objects.TestIamPermissions

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Storage.Objects
```
public class Storage.Objects.TestIamPermissions
extends StorageRequest<TestIamPermissionsResponse>
```

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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.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(java.lang.String bucket, java.lang.String object__, java.util.List<java.lang.String> permissions)` Tests a set of permissions on the given object to see which, if any, are held by the caller.

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()`
`java.lang.String`	`getBucket()` Name of the bucket in which the object resides.
`java.lang.Long`	`getGeneration()` If present, selects a specific revision of this object (as opposed to the latest version, the default).
`java.lang.String`	`getObject()` Name of the object.
`java.util.List<java.lang.String>`	`getPermissions()` Permissions to test.
`java.lang.String`	`getProvisionalUserProject()` The project to be billed for this request if the target bucket is requester-pays bucket.
`java.lang.String`	`getUserProject()` The project to be billed for this request.
`Storage.Objects.TestIamPermissions`	`set(java.lang.String parameterName, java.lang.Object value)`
`Storage.Objects.TestIamPermissions`	`setAlt(java.lang.String alt)` Data format for the response.
`Storage.Objects.TestIamPermissions`	`setBucket(java.lang.String bucket)` Name of the bucket in which the object resides.
`Storage.Objects.TestIamPermissions`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Storage.Objects.TestIamPermissions`	`setGeneration(java.lang.Long generation)` If present, selects a specific revision of this object (as opposed to the latest version, the default).
`Storage.Objects.TestIamPermissions`	`setKey(java.lang.String key)` API key.
`Storage.Objects.TestIamPermissions`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Storage.Objects.TestIamPermissions`	`setObject(java.lang.String object__)` Name of the object.
`Storage.Objects.TestIamPermissions`	`setPermissions(java.util.List<java.lang.String> permissions)` Permissions to test.
`Storage.Objects.TestIamPermissions`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Storage.Objects.TestIamPermissions`	`setProvisionalUserProject(java.lang.String provisionalUserProject)` The project to be billed for this request if the target bucket is requester-pays bucket.
`Storage.Objects.TestIamPermissions`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`Storage.Objects.TestIamPermissions`	`setUserIp(java.lang.String userIp)` Deprecated.
`Storage.Objects.TestIamPermissions`	`setUserProject(java.lang.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, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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(java.lang.String bucket,
                             java.lang.String object__,
                             java.util.List<java.lang.String> permissions)
```
    Tests a set of permissions on the given object to see which, if any, are held by the caller. Create a request for the method "objects.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 the bucket in which the object resides.
    
    object__ - Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
    
    permissions - Permissions to test.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<TestIamPermissionsResponse>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<TestIamPermissionsResponse>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Storage.Objects.TestIamPermissions setAlt(java.lang.String alt)
```
    Description copied from class: StorageRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class StorageRequest<TestIamPermissionsResponse>
  - setFields
```
public Storage.Objects.TestIamPermissions setFields(java.lang.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.Objects.TestIamPermissions setKey(java.lang.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.Objects.TestIamPermissions setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: StorageRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class StorageRequest<TestIamPermissionsResponse>
  - setPrettyPrint
```
public Storage.Objects.TestIamPermissions setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: StorageRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class StorageRequest<TestIamPermissionsResponse>
  - setQuotaUser
```
public Storage.Objects.TestIamPermissions setQuotaUser(java.lang.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>
  - setUserIp
```
public Storage.Objects.TestIamPermissions setUserIp(java.lang.String userIp)
```
    Description copied from class: StorageRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class StorageRequest<TestIamPermissionsResponse>
  - getBucket
```
public java.lang.String getBucket()
```
    Name of the bucket in which the object resides.
  - setBucket
```
public Storage.Objects.TestIamPermissions setBucket(java.lang.String bucket)
```
    Name of the bucket in which the object resides.
  - getObject
```
public java.lang.String getObject()
```
    Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  - setObject
```
public Storage.Objects.TestIamPermissions setObject(java.lang.String object__)
```
    Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  - getPermissions
```
public java.util.List<java.lang.String> getPermissions()
```
    Permissions to test.
  - setPermissions
```
public Storage.Objects.TestIamPermissions setPermissions(java.util.List<java.lang.String> permissions)
```
    Permissions to test.
  - getGeneration
```
public java.lang.Long getGeneration()
```
    If present, selects a specific revision of this object (as opposed to the latest version, the default).
  - setGeneration
```
public Storage.Objects.TestIamPermissions setGeneration(java.lang.Long generation)
```
    If present, selects a specific revision of this object (as opposed to the latest version, the default).
  - getProvisionalUserProject
```
public java.lang.String getProvisionalUserProject()
```
    The project to be billed for this request if the target bucket is requester-pays bucket.
  - setProvisionalUserProject
```
public Storage.Objects.TestIamPermissions setProvisionalUserProject(java.lang.String provisionalUserProject)
```
    The project to be billed for this request if the target bucket is requester-pays bucket.
  - getUserProject
```
public java.lang.String getUserProject()
```
    The project to be billed for this request. Required for Requester Pays buckets.
  - setUserProject
```
public Storage.Objects.TestIamPermissions setUserProject(java.lang.String userProject)
```
    The project to be billed for this request. Required for Requester Pays buckets.
  - set
```
public Storage.Objects.TestIamPermissions set(java.lang.String parameterName,
                                              java.lang.Object value)
```
    Overrides:
    
    set in class StorageRequest<TestIamPermissionsResponse>

Cloud Storage JSON API v1 (revision 171)

Class Storage.Objects.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

setUserIp

getBucket

setBucket

getObject

setObject

getPermissions

setPermissions

getGeneration

setGeneration

getProvisionalUserProject

setProvisionalUserProject

getUserProject

setUserProject

set