target.apidocs.com.google.api.services.cloudchannel.v1.Cloudchannel.Accounts.Customers.Entitlements.Cancel.html Maven / Gradle / Ivy
Cloudchannel.Accounts.Customers.Entitlements.Cancel (Cloud Channel API v1-rev20241109-2.0.0)
com.google.api.services.cloudchannel.v1
Class Cloudchannel.Accounts.Customers.Entitlements.Cancel
- 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.cloudchannel.v1.CloudchannelRequest<GoogleLongrunningOperation>
-
- com.google.api.services.cloudchannel.v1.Cloudchannel.Accounts.Customers.Entitlements.Cancel
-
- Enclosing class:
- Cloudchannel.Accounts.Customers.Entitlements
public class Cloudchannel.Accounts.Customers.Entitlements.Cancel
extends CloudchannelRequest<GoogleLongrunningOperation>
-
-
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
Cancel(String name,
GoogleCloudChannelV1CancelEntitlementRequest content)
Cancels a previously fulfilled entitlement.
-
Method Summary
-
Methods inherited from class com.google.api.services.cloudchannel.v1.CloudchannelRequest
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
-
Cancel
protected Cancel(String name,
GoogleCloudChannelV1CancelEntitlementRequest content)
Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running
operation. Possible error codes: * PERMISSION_DENIED: The reseller account making the request
is different from the reseller account in the API request. * FAILED_PRECONDITION: There are
Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount. *
INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement
resource not found. * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace
add-ons, or entitlements for Google Cloud's development platform. * INTERNAL: Any non-user
error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN:
Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation. To get the results of the operation, call the
GetOperation method of CloudChannelOperationsService. The response will contain
google.protobuf.Empty on success. The Operation metadata will contain an instance of
OperationMetadata.
Create a request for the method "entitlements.cancel".
This request holds the parameters needed by the the cloudchannel server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
Cloudchannel.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must
be called to initialize this instance immediately after invoking the constructor.
- Parameters:
name
- Required. The resource name of the entitlement to cancel. Name uses the format:
accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
content
- the GoogleCloudChannelV1CancelEntitlementRequest
- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Cloudchannel.Accounts.Customers.Entitlements.Cancel set$Xgafv(String $Xgafv)
Description copied from class: CloudchannelRequest
V1 error format.
- Overrides:
set$Xgafv
in class CloudchannelRequest<GoogleLongrunningOperation>
-
setAccessToken
public Cloudchannel.Accounts.Customers.Entitlements.Cancel setAccessToken(String accessToken)
Description copied from class: CloudchannelRequest
OAuth access token.
- Overrides:
setAccessToken
in class CloudchannelRequest<GoogleLongrunningOperation>
-
setAlt
public Cloudchannel.Accounts.Customers.Entitlements.Cancel setAlt(String alt)
Description copied from class: CloudchannelRequest
Data format for response.
- Overrides:
setAlt
in class CloudchannelRequest<GoogleLongrunningOperation>
-
setCallback
public Cloudchannel.Accounts.Customers.Entitlements.Cancel setCallback(String callback)
Description copied from class: CloudchannelRequest
JSONP
- Overrides:
setCallback
in class CloudchannelRequest<GoogleLongrunningOperation>
-
setFields
public Cloudchannel.Accounts.Customers.Entitlements.Cancel setFields(String fields)
Description copied from class: CloudchannelRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class CloudchannelRequest<GoogleLongrunningOperation>
-
setKey
public Cloudchannel.Accounts.Customers.Entitlements.Cancel setKey(String key)
Description copied from class: CloudchannelRequest
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 CloudchannelRequest<GoogleLongrunningOperation>
-
setOauthToken
public Cloudchannel.Accounts.Customers.Entitlements.Cancel setOauthToken(String oauthToken)
Description copied from class: CloudchannelRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class CloudchannelRequest<GoogleLongrunningOperation>
-
setPrettyPrint
public Cloudchannel.Accounts.Customers.Entitlements.Cancel setPrettyPrint(Boolean prettyPrint)
Description copied from class: CloudchannelRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class CloudchannelRequest<GoogleLongrunningOperation>
-
setQuotaUser
public Cloudchannel.Accounts.Customers.Entitlements.Cancel setQuotaUser(String quotaUser)
Description copied from class: CloudchannelRequest
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 CloudchannelRequest<GoogleLongrunningOperation>
-
setUploadType
public Cloudchannel.Accounts.Customers.Entitlements.Cancel setUploadType(String uploadType)
Description copied from class: CloudchannelRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class CloudchannelRequest<GoogleLongrunningOperation>
-
setUploadProtocol
public Cloudchannel.Accounts.Customers.Entitlements.Cancel setUploadProtocol(String uploadProtocol)
Description copied from class: CloudchannelRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class CloudchannelRequest<GoogleLongrunningOperation>
-
getName
public String getName()
Required. The resource name of the entitlement to cancel. Name uses the format:
accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
-
setName
public Cloudchannel.Accounts.Customers.Entitlements.Cancel setName(String name)
Required. The resource name of the entitlement to cancel. Name uses the format:
accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
-
set
public Cloudchannel.Accounts.Customers.Entitlements.Cancel set(String parameterName,
Object value)
- Overrides:
set
in class CloudchannelRequest<GoogleLongrunningOperation>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy