target.apidocs.com.google.api.services.pubsub.Pubsub.Projects.Subscriptions.Patch.html Maven / Gradle / Ivy
Pubsub.Projects.Subscriptions.Patch (Cloud Pub/Sub API v1-rev20240918-2.0.0)
com.google.api.services.pubsub
Class Pubsub.Projects.Subscriptions.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.pubsub.PubsubRequest<Subscription>
-
- com.google.api.services.pubsub.Pubsub.Projects.Subscriptions.Patch
-
- Enclosing class:
- Pubsub.Projects.Subscriptions
public class Pubsub.Projects.Subscriptions.Patch
extends PubsubRequest<Subscription>
-
-
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,
UpdateSubscriptionRequest content)
Updates an existing subscription by updating the fields specified in the update mask.
-
Method Summary
-
Methods inherited from class com.google.api.services.pubsub.PubsubRequest
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,
UpdateSubscriptionRequest content)
Updates an existing subscription by updating the fields specified in the update mask. Note that
certain properties of a subscription, such as its topic, are not modifiable.
Create a request for the method "subscriptions.patch".
This request holds the parameters needed by the the pubsub server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation. Pubsub.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must
be called to initialize this instance immediately after invoking the constructor.
- Parameters:
name - Required. The name of the subscription. It must have the format
`"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a
letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must
be between 3 and 255 characters in length, and it must not start with `"goog"`.content - the UpdateSubscriptionRequest- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Pubsub.Projects.Subscriptions.Patch set$Xgafv(String $Xgafv)
Description copied from class: PubsubRequest
V1 error format.
- Overrides:
set$Xgafv in class PubsubRequest<Subscription>
-
setAccessToken
public Pubsub.Projects.Subscriptions.Patch setAccessToken(String accessToken)
Description copied from class: PubsubRequest
OAuth access token.
- Overrides:
setAccessToken in class PubsubRequest<Subscription>
-
setAlt
public Pubsub.Projects.Subscriptions.Patch setAlt(String alt)
Description copied from class: PubsubRequest
Data format for response.
- Overrides:
setAlt in class PubsubRequest<Subscription>
-
setCallback
public Pubsub.Projects.Subscriptions.Patch setCallback(String callback)
Description copied from class: PubsubRequest
JSONP
- Overrides:
setCallback in class PubsubRequest<Subscription>
-
setFields
public Pubsub.Projects.Subscriptions.Patch setFields(String fields)
Description copied from class: PubsubRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class PubsubRequest<Subscription>
-
setKey
public Pubsub.Projects.Subscriptions.Patch setKey(String key)
Description copied from class: PubsubRequest
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 PubsubRequest<Subscription>
-
setOauthToken
public Pubsub.Projects.Subscriptions.Patch setOauthToken(String oauthToken)
Description copied from class: PubsubRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class PubsubRequest<Subscription>
-
setPrettyPrint
public Pubsub.Projects.Subscriptions.Patch setPrettyPrint(Boolean prettyPrint)
Description copied from class: PubsubRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class PubsubRequest<Subscription>
-
setQuotaUser
public Pubsub.Projects.Subscriptions.Patch setQuotaUser(String quotaUser)
Description copied from class: PubsubRequest
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 PubsubRequest<Subscription>
-
setUploadType
public Pubsub.Projects.Subscriptions.Patch setUploadType(String uploadType)
Description copied from class: PubsubRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class PubsubRequest<Subscription>
-
setUploadProtocol
public Pubsub.Projects.Subscriptions.Patch setUploadProtocol(String uploadProtocol)
Description copied from class: PubsubRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class PubsubRequest<Subscription>
-
getName
public String getName()
Required. The name of the subscription. It must have the format
`"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and
contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods
(`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in
length, and it must not start with `"goog"`.
-
setName
public Pubsub.Projects.Subscriptions.Patch setName(String name)
Required. The name of the subscription. It must have the format
`"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a
letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It
must be between 3 and 255 characters in length, and it must not start with `"goog"`.
-
set
public Pubsub.Projects.Subscriptions.Patch set(String parameterName,
Object value)
- Overrides:
set in class PubsubRequest<Subscription>
Copyright © 2011–2024 Google. All rights reserved.