target.apidocs.com.google.api.services.cloudidentity.v1.CloudIdentity.Devices.DeviceUsers.ClientStates.Patch.html Maven / Gradle / Ivy
CloudIdentity.Devices.DeviceUsers.ClientStates.Patch (Cloud Identity API v1-rev20230808-2.0.0)
com.google.api.services.cloudidentity.v1
Class CloudIdentity.Devices.DeviceUsers.ClientStates.Patch
- 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.cloudidentity.v1.CloudIdentityRequest<Operation>
-
- com.google.api.services.cloudidentity.v1.CloudIdentity.Devices.DeviceUsers.ClientStates.Patch
-
- Enclosing class:
- CloudIdentity.Devices.DeviceUsers.ClientStates
public class CloudIdentity.Devices.DeviceUsers.ClientStates.Patch
extends CloudIdentityRequest<Operation>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected Patch(String name,
GoogleAppsCloudidentityDevicesV1ClientState content)
Updates the client state for the device user **Note**: This method is available only to
customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise
for Education, and Cloud Identity Premium
Create a request for the method "clientStates.patch".
-
Method Summary
-
Methods inherited from class com.google.api.services.cloudidentity.v1.CloudIdentityRequest
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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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
-
Patch
protected Patch(String name,
GoogleAppsCloudidentityDevicesV1ClientState content)
Updates the client state for the device user **Note**: This method is available only to
customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise
for Education, and Cloud Identity Premium
Create a request for the method "clientStates.patch".
This request holds the parameters needed by the the cloudidentity server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
CloudIdentity.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must
be called to initialize this instance immediately after invoking the constructor.
- Parameters:
name - Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState
in format: `devices/{device}/deviceUsers/{device_user}/clientState/{partner}`, where
partner corresponds to the partner storing the data. For partners belonging to the
"BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other
callers, this is a string of the form: `{customer}-suffix`, where `customer` is your
customer ID. The *suffix* is any string the caller specifies. This string will be
displayed verbatim in the administration console. This suffix is used in setting up Custom
Access Levels in Context-Aware Access. Your organization's customer ID can be obtained
from the URL: `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer`
The `id` field in the response contains the customer ID starting with the letter 'C'. The
customer ID to be used in this API is the string after the letter 'C' (not including 'C')content - the GoogleAppsCloudidentityDevicesV1ClientState- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch set$Xgafv(String $Xgafv)
Description copied from class: CloudIdentityRequest
V1 error format.
- Overrides:
set$Xgafv in class CloudIdentityRequest<Operation>
-
setAccessToken
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setAccessToken(String accessToken)
Description copied from class: CloudIdentityRequest
OAuth access token.
- Overrides:
setAccessToken in class CloudIdentityRequest<Operation>
-
setAlt
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setAlt(String alt)
Description copied from class: CloudIdentityRequest
Data format for response.
- Overrides:
setAlt in class CloudIdentityRequest<Operation>
-
setCallback
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setCallback(String callback)
Description copied from class: CloudIdentityRequest
JSONP
- Overrides:
setCallback in class CloudIdentityRequest<Operation>
-
setFields
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setFields(String fields)
Description copied from class: CloudIdentityRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class CloudIdentityRequest<Operation>
-
setKey
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setKey(String key)
Description copied from class: CloudIdentityRequest
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 CloudIdentityRequest<Operation>
-
setOauthToken
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setOauthToken(String oauthToken)
Description copied from class: CloudIdentityRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class CloudIdentityRequest<Operation>
-
setPrettyPrint
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setPrettyPrint(Boolean prettyPrint)
Description copied from class: CloudIdentityRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class CloudIdentityRequest<Operation>
-
setQuotaUser
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setQuotaUser(String quotaUser)
Description copied from class: CloudIdentityRequest
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 CloudIdentityRequest<Operation>
-
setUploadType
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setUploadType(String uploadType)
Description copied from class: CloudIdentityRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class CloudIdentityRequest<Operation>
-
setUploadProtocol
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setUploadProtocol(String uploadProtocol)
Description copied from class: CloudIdentityRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class CloudIdentityRequest<Operation>
-
getName
public String getName()
Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
ClientState in format: `devices/{device}/deviceUsers/{device_user}/clientState/{partner}`, where
partner corresponds to the partner storing the data. For partners belonging to the "BeyondCorp
Alliance", this is the partner ID specified to you by Google. For all other callers, this is a
string of the form: `{customer}-suffix`, where `customer` is your customer ID. The *suffix* is any
string the caller specifies. This string will be displayed verbatim in the administration console.
This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's
customer ID can be obtained from the URL: `GET
https://www.googleapis.com/admin/directory/v1/customers/my_customer` The `id` field in the response
contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is
the string after the letter 'C' (not including 'C')
-
setName
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setName(String name)
Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of
the ClientState in format:
`devices/{device}/deviceUsers/{device_user}/clientState/{partner}`, where partner
corresponds to the partner storing the data. For partners belonging to the "BeyondCorp
Alliance", this is the partner ID specified to you by Google. For all other callers,
this is a string of the form: `{customer}-suffix`, where `customer` is your customer
ID. The *suffix* is any string the caller specifies. This string will be displayed
verbatim in the administration console. This suffix is used in setting up Custom Access
Levels in Context-Aware Access. Your organization's customer ID can be obtained from
the URL: `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The
`id` field in the response contains the customer ID starting with the letter 'C'. The
customer ID to be used in this API is the string after the letter 'C' (not including
'C')
-
getCustomer
public String getCustomer()
Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If
you're using this API for your own organization, use `customers/my_customer` If you're using this
API to manage another organization, use `customers/{customer}`, where customer is the customer to
whom the device belongs.
-
setCustomer
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setCustomer(String customer)
Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the
customer. If you're using this API for your own organization, use
`customers/my_customer` If you're using this API to manage another organization, use
`customers/{customer}`, where customer is the customer to whom the device belongs.
-
getUpdateMask
public String getUpdateMask()
Optional. Comma-separated list of fully qualified names of fields to be updated. If not specified,
all updatable fields in ClientState are updated.
-
setUpdateMask
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch setUpdateMask(String updateMask)
Optional. Comma-separated list of fully qualified names of fields to be updated. If not
specified, all updatable fields in ClientState are updated.
-
set
public CloudIdentity.Devices.DeviceUsers.ClientStates.Patch set(String parameterName,
Object value)
- Overrides:
set in class CloudIdentityRequest<Operation>
Copyright © 2011–2023 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy