com.google.api.services.iam.v1

Class Iam.Projects.Roles.Get

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.iam.v1.IamRequest<Role>

com.google.api.services.iam.v1.Iam.Projects.Roles.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Iam.Projects.Roles

public class Iam.Projects.Roles.Get
extends IamRequest<Role>

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	Get(String name) Gets a Role definition.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getName() The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles).
Iam.Projects.Roles.Get	set(String parameterName, Object value)
Iam.Projects.Roles.Get	set$Xgafv(String $Xgafv) V1 error format.
Iam.Projects.Roles.Get	setAccessToken(String accessToken) OAuth access token.
Iam.Projects.Roles.Get	setAlt(String alt) Data format for response.
Iam.Projects.Roles.Get	setCallback(String callback) JSONP
Iam.Projects.Roles.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Iam.Projects.Roles.Get	setKey(String key) API key.
Iam.Projects.Roles.Get	setName(String name) The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles).
Iam.Projects.Roles.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Iam.Projects.Roles.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Iam.Projects.Roles.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Iam.Projects.Roles.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Iam.Projects.Roles.Get	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.iam.v1.IamRequest

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, 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

Get

protected Get(String name)

Gets a Role definition. Create a request for the method "roles.get". This request holds the parameters needed by the the iam server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Iam.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

name - The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](/iam/docs /understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Role>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Role>

Throws:

IOException

set$Xgafv

public Iam.Projects.Roles.Get set$Xgafv(String $Xgafv)

Description copied from class: IamRequest

V1 error format.

Overrides:

set$Xgafv in class IamRequest<Role>

setAccessToken

public Iam.Projects.Roles.Get setAccessToken(String accessToken)

Description copied from class: IamRequest

OAuth access token.

Overrides:

setAccessToken in class IamRequest<Role>

setAlt

public Iam.Projects.Roles.Get setAlt(String alt)

Description copied from class: IamRequest

Data format for response.

Overrides:

setAlt in class IamRequest<Role>

setCallback

public Iam.Projects.Roles.Get setCallback(String callback)

Description copied from class: IamRequest

JSONP

Overrides:

setCallback in class IamRequest<Role>

setFields

public Iam.Projects.Roles.Get setFields(String fields)

Description copied from class: IamRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class IamRequest<Role>

setKey

public Iam.Projects.Roles.Get setKey(String key)

Description copied from class: IamRequest

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 IamRequest<Role>

setOauthToken

public Iam.Projects.Roles.Get setOauthToken(String oauthToken)

Description copied from class: IamRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class IamRequest<Role>

setPrettyPrint

public Iam.Projects.Roles.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: IamRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class IamRequest<Role>

setQuotaUser

public Iam.Projects.Roles.Get setQuotaUser(String quotaUser)

Description copied from class: IamRequest

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 IamRequest<Role>

setUploadType

public Iam.Projects.Roles.Get setUploadType(String uploadType)

Description copied from class: IamRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class IamRequest<Role>

setUploadProtocol

public Iam.Projects.Roles.Get setUploadProtocol(String uploadProtocol)

Description copied from class: IamRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class IamRequest<Role>

getName

public String getName()

The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs /understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

setName

public Iam.Projects.Roles.Get setName(String name)

The `name` parameter's value depends on the target resource for the request, namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`. This method returns results from all [predefined roles](/iam/docs/understanding- roles#predefined_roles) in Cloud IAM. Example request URL: `https://iam.googleapis.com/v1/roles/{ROLE_NAME}` * [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only [custom roles](/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

set

public Iam.Projects.Roles.Get set(String parameterName,
                                  Object value)

Overrides:

set in class IamRequest<Role>