com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy

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.discoveryengine.v1.DiscoveryEngineRequest<GoogleIamV1Policy>

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.Engines

public class DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy
extends DiscoveryEngineRequest<GoogleIamV1Policy>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetIamPolicy(String resource) Gets the IAM access control policy for an Engine.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getOptionsRequestedPolicyVersion() Optional.
String	getResource() REQUIRED: The resource for which the policy is being requested.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setOptionsRequestedPolicyVersion(Integer optionsRequestedPolicyVersion) Optional.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setResource(String resource) REQUIRED: The resource for which the policy is being requested.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest

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

GetIamPolicy

protected GetIamPolicy(String resource)

Gets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Create a request for the method "engines.getIamPolicy". This request holds the parameters needed by the the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy set$Xgafv(String $Xgafv)

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleIamV1Policy>

setAccessToken

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleIamV1Policy>

setAlt

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleIamV1Policy>

setCallback

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleIamV1Policy>

setFields

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setFields(String fields)

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleIamV1Policy>

setKey

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setKey(String key)

Description copied from class: DiscoveryEngineRequest

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 DiscoveryEngineRequest<GoogleIamV1Policy>

setOauthToken

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setOauthToken(String oauthToken)

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleIamV1Policy>

setPrettyPrint

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleIamV1Policy>

setQuotaUser

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setQuotaUser(String quotaUser)

Description copied from class: DiscoveryEngineRequest

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 DiscoveryEngineRequest<GoogleIamV1Policy>

setUploadType

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setUploadType(String uploadType)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleIamV1Policy>

setUploadProtocol

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleIamV1Policy>

getResource

public String getResource()

REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

setResource

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setResource(String resource)

REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

getOptionsRequestedPolicyVersion

public Integer getOptionsRequestedPolicyVersion()

Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

setOptionsRequestedPolicyVersion

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy setOptionsRequestedPolicyVersion(Integer optionsRequestedPolicyVersion)

Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

set

public DiscoveryEngine.Projects.Locations.Collections.Engines.GetIamPolicy set(String parameterName,
                                                                               Object value)

Overrides:

set in class DiscoveryEngineRequest<GoogleIamV1Policy>