com.google.api.services.iam.v2

Class Iam.Policies.ListPolicies

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.v2.IamRequest<GoogleIamV2ListPoliciesResponse>

com.google.api.services.iam.v2.Iam.Policies.ListPolicies

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Iam.Policies

public class Iam.Policies.ListPolicies
extends IamRequest<GoogleIamV2ListPoliciesResponse>

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	ListPolicies(String parent) Retrieves the policies of the specified kind that are attached to a resource.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getPageSize() The maximum number of policies to return.
String	getPageToken() A page token received in a ListPoliciesResponse.
String	getParent() Required.
Iam.Policies.ListPolicies	set(String parameterName, Object value)
Iam.Policies.ListPolicies	set$Xgafv(String $Xgafv) V1 error format.
Iam.Policies.ListPolicies	setAccessToken(String accessToken) OAuth access token.
Iam.Policies.ListPolicies	setAlt(String alt) Data format for response.
Iam.Policies.ListPolicies	setCallback(String callback) JSONP
Iam.Policies.ListPolicies	setFields(String fields) Selector specifying which fields to include in a partial response.
Iam.Policies.ListPolicies	setKey(String key) API key.
Iam.Policies.ListPolicies	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Iam.Policies.ListPolicies	setPageSize(Integer pageSize) The maximum number of policies to return.
Iam.Policies.ListPolicies	setPageToken(String pageToken) A page token received in a ListPoliciesResponse.
Iam.Policies.ListPolicies	setParent(String parent) Required.
Iam.Policies.ListPolicies	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Iam.Policies.ListPolicies	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Iam.Policies.ListPolicies	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Iam.Policies.ListPolicies	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.iam.v2.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, 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

ListPolicies

protected ListPolicies(String parent)

Retrieves the policies of the specified kind that are attached to a resource. The response lists only policy metadata. In particular, policy rules are omitted. Create a request for the method "policies.listPolicies". 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:

parent - Required. The resource that the policy is attached to, along with the kind of policy to list. Format: `policies/{attachment_point}/denypolicies` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

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

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleIamV2ListPoliciesResponse>

Throws:

IOException

set$Xgafv

public Iam.Policies.ListPolicies set$Xgafv(String $Xgafv)

Description copied from class: IamRequest

V1 error format.

Overrides:

set$Xgafv in class IamRequest<GoogleIamV2ListPoliciesResponse>

setAccessToken

public Iam.Policies.ListPolicies setAccessToken(String accessToken)

Description copied from class: IamRequest

OAuth access token.

Overrides:

setAccessToken in class IamRequest<GoogleIamV2ListPoliciesResponse>

setAlt

public Iam.Policies.ListPolicies setAlt(String alt)

Description copied from class: IamRequest

Data format for response.

Overrides:

setAlt in class IamRequest<GoogleIamV2ListPoliciesResponse>

setCallback

public Iam.Policies.ListPolicies setCallback(String callback)

Description copied from class: IamRequest

JSONP

Overrides:

setCallback in class IamRequest<GoogleIamV2ListPoliciesResponse>

setFields

public Iam.Policies.ListPolicies setFields(String fields)

Description copied from class: IamRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class IamRequest<GoogleIamV2ListPoliciesResponse>

setKey

public Iam.Policies.ListPolicies 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<GoogleIamV2ListPoliciesResponse>

setOauthToken

public Iam.Policies.ListPolicies setOauthToken(String oauthToken)

Description copied from class: IamRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class IamRequest<GoogleIamV2ListPoliciesResponse>

setPrettyPrint

public Iam.Policies.ListPolicies setPrettyPrint(Boolean prettyPrint)

Description copied from class: IamRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class IamRequest<GoogleIamV2ListPoliciesResponse>

setQuotaUser

public Iam.Policies.ListPolicies 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<GoogleIamV2ListPoliciesResponse>

setUploadType

public Iam.Policies.ListPolicies setUploadType(String uploadType)

Description copied from class: IamRequest

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

Overrides:

setUploadType in class IamRequest<GoogleIamV2ListPoliciesResponse>

setUploadProtocol

public Iam.Policies.ListPolicies setUploadProtocol(String uploadProtocol)

Description copied from class: IamRequest

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

Overrides:

setUploadProtocol in class IamRequest<GoogleIamV2ListPoliciesResponse>

getParent

public String getParent()

Required. The resource that the policy is attached to, along with the kind of policy to list. Format: `policies/{attachment_point}/denypolicies` The attachment point is identified by its URL- encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy- project/denypolicies`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

setParent

public Iam.Policies.ListPolicies setParent(String parent)

Required. The resource that the policy is attached to, along with the kind of policy to list. Format: `policies/{attachment_point}/denypolicies` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

getPageSize

public Integer getPageSize()

The maximum number of policies to return. IAM ignores this value and uses the value 1000.

setPageSize

public Iam.Policies.ListPolicies setPageSize(Integer pageSize)

The maximum number of policies to return. IAM ignores this value and uses the value 1000.

getPageToken

public String getPageToken()

A page token received in a ListPoliciesResponse. Provide this token to retrieve the next page.

setPageToken

public Iam.Policies.ListPolicies setPageToken(String pageToken)

A page token received in a ListPoliciesResponse. Provide this token to retrieve the next page.

set

public Iam.Policies.ListPolicies set(String parameterName,
                                     Object value)

Overrides:

set in class IamRequest<GoogleIamV2ListPoliciesResponse>