com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings

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

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.IdentityMappingStores

public class DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings
extends DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

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	ListIdentityMappings(String identityMappingStore) Lists Identity Mappings in an Identity Mapping Store.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getIdentityMappingStore() Required.
Integer	getPageSize() Maximum number of IdentityMappings to return.
String	getPageToken() A page token, received from a previous `ListIdentityMappings` call.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setIdentityMappingStore(String identityMappingStore) Required.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setPageSize(Integer pageSize) Maximum number of IdentityMappings to return.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setPageToken(String pageToken) A page token, received from a previous `ListIdentityMappings` call.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings	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

ListIdentityMappings

protected ListIdentityMappings(String identityMappingStore)

Lists Identity Mappings in an Identity Mapping Store. Create a request for the method "identityMappingStores.listIdentityMappings". 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.

ListIdentityMappings#initialize(com.google.api.client.googleapis.s ervices.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

identityMappingStore - Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings set$Xgafv(String $Xgafv)

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

setAccessToken

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

setAlt

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

setCallback

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

setFields

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings setFields(String fields)

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

setKey

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings 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<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

setOauthToken

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings setOauthToken(String oauthToken)

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

setPrettyPrint

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

setQuotaUser

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings 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<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

setUploadType

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings setUploadType(String uploadType)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

setUploadProtocol

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>

getIdentityMappingStore

public String getIdentityMappingStore()

Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`

setIdentityMappingStore

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings setIdentityMappingStore(String identityMappingStore)

Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`

getPageSize

public Integer getPageSize()

Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.

setPageSize

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings setPageSize(Integer pageSize)

Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.

getPageToken

public String getPageToken()

A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token.

setPageToken

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings setPageToken(String pageToken)

A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token.

set

public DiscoveryEngine.Projects.Locations.IdentityMappingStores.ListIdentityMappings set(String parameterName,
                                                                                         Object value)

Overrides:

set in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListIdentityMappingsResponse>