target.apidocs.com.google.api.services.texttospeech.v1.Texttospeech.Operations.Cancel.html Maven / Gradle / Ivy
Texttospeech.Operations.Cancel (Cloud Text-to-Speech API v1-rev20240815-2.0.0)
com.google.api.services.texttospeech.v1
Class Texttospeech.Operations.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.texttospeech.v1.TexttospeechRequest<Empty>
-
- com.google.api.services.texttospeech.v1.Texttospeech.Operations.Cancel
-
- Enclosing class:
- Texttospeech.Operations
public class Texttospeech.Operations.Cancel
extends TexttospeechRequest<Empty>
-
-
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,
CancelOperationRequest content)
Starts asynchronous cancellation on a long-running operation.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getName()
The name of the operation resource to be cancelled.
Texttospeech.Operations.Cancel
set(String parameterName,
Object value)
Texttospeech.Operations.Cancel
set$Xgafv(String $Xgafv)
V1 error format.
Texttospeech.Operations.Cancel
setAccessToken(String accessToken)
OAuth access token.
Texttospeech.Operations.Cancel
setAlt(String alt)
Data format for response.
Texttospeech.Operations.Cancel
setCallback(String callback)
JSONP
Texttospeech.Operations.Cancel
setFields(String fields)
Selector specifying which fields to include in a partial response.
Texttospeech.Operations.Cancel
setKey(String key)
API key.
Texttospeech.Operations.Cancel
setName(String name)
The name of the operation resource to be cancelled.
Texttospeech.Operations.Cancel
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Texttospeech.Operations.Cancel
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Texttospeech.Operations.Cancel
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Texttospeech.Operations.Cancel
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Texttospeech.Operations.Cancel
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
-
Methods inherited from class com.google.api.services.texttospeech.v1.TexttospeechRequest
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,
CancelOperationRequest content)
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
`Code.CANCELLED`.
Create a request for the method "operations.cancel".
This request holds the parameters needed by the the texttospeech server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
Texttospeech.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must
be called to initialize this instance immediately after invoking the constructor.
- Parameters:
name
- The name of the operation resource to be cancelled.
content
- the CancelOperationRequest
- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Texttospeech.Operations.Cancel set$Xgafv(String $Xgafv)
Description copied from class: TexttospeechRequest
V1 error format.
- Overrides:
set$Xgafv
in class TexttospeechRequest<Empty>
-
setAccessToken
public Texttospeech.Operations.Cancel setAccessToken(String accessToken)
Description copied from class: TexttospeechRequest
OAuth access token.
- Overrides:
setAccessToken
in class TexttospeechRequest<Empty>
-
setAlt
public Texttospeech.Operations.Cancel setAlt(String alt)
Description copied from class: TexttospeechRequest
Data format for response.
- Overrides:
setAlt
in class TexttospeechRequest<Empty>
-
setCallback
public Texttospeech.Operations.Cancel setCallback(String callback)
Description copied from class: TexttospeechRequest
JSONP
- Overrides:
setCallback
in class TexttospeechRequest<Empty>
-
setFields
public Texttospeech.Operations.Cancel setFields(String fields)
Description copied from class: TexttospeechRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class TexttospeechRequest<Empty>
-
setKey
public Texttospeech.Operations.Cancel setKey(String key)
Description copied from class: TexttospeechRequest
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 TexttospeechRequest<Empty>
-
setOauthToken
public Texttospeech.Operations.Cancel setOauthToken(String oauthToken)
Description copied from class: TexttospeechRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class TexttospeechRequest<Empty>
-
setPrettyPrint
public Texttospeech.Operations.Cancel setPrettyPrint(Boolean prettyPrint)
Description copied from class: TexttospeechRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class TexttospeechRequest<Empty>
-
setQuotaUser
public Texttospeech.Operations.Cancel setQuotaUser(String quotaUser)
Description copied from class: TexttospeechRequest
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 TexttospeechRequest<Empty>
-
setUploadType
public Texttospeech.Operations.Cancel setUploadType(String uploadType)
Description copied from class: TexttospeechRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class TexttospeechRequest<Empty>
-
setUploadProtocol
public Texttospeech.Operations.Cancel setUploadProtocol(String uploadProtocol)
Description copied from class: TexttospeechRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class TexttospeechRequest<Empty>
-
getName
public String getName()
The name of the operation resource to be cancelled.
-
setName
public Texttospeech.Operations.Cancel setName(String name)
The name of the operation resource to be cancelled.
-
set
public Texttospeech.Operations.Cancel set(String parameterName,
Object value)
- Overrides:
set
in class TexttospeechRequest<Empty>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy