com.google.api.services.pubsub

Class Pubsub.Projects.Subscriptions.Create

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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.Create

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Pubsub.Projects.Subscriptions

public class Pubsub.Projects.Subscriptions.Create
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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Pubsub.Projects.Subscriptions.Create(java.lang.String name, Subscription content) Creates a subscription to a given topic.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() The name of the subscription.
Pubsub.Projects.Subscriptions.Create	set(java.lang.String parameterName, java.lang.Object value)
Pubsub.Projects.Subscriptions.Create	set$Xgafv(java.lang.String $Xgafv) V1 error format.
Pubsub.Projects.Subscriptions.Create	setAccessToken(java.lang.String accessToken) OAuth access token.
Pubsub.Projects.Subscriptions.Create	setAlt(java.lang.String alt) Data format for response.
Pubsub.Projects.Subscriptions.Create	setBearerToken(java.lang.String bearerToken) OAuth bearer token.
Pubsub.Projects.Subscriptions.Create	setCallback(java.lang.String callback) JSONP
Pubsub.Projects.Subscriptions.Create	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Pubsub.Projects.Subscriptions.Create	setKey(java.lang.String key) API key.
Pubsub.Projects.Subscriptions.Create	setName(java.lang.String name) The name of the subscription.
Pubsub.Projects.Subscriptions.Create	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Pubsub.Projects.Subscriptions.Create	setPp(java.lang.Boolean pp) Pretty-print response.
Pubsub.Projects.Subscriptions.Create	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Pubsub.Projects.Subscriptions.Create	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Pubsub.Projects.Subscriptions.Create	setUploadProtocol(java.lang.String uploadProtocol) Upload protocol for media (e.g.
Pubsub.Projects.Subscriptions.Create	setUploadType(java.lang.String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.pubsub.PubsubRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getBearerToken, getCallback, getFields, getKey, getOauthToken, getPp, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Pubsub.Projects.Subscriptions.Create

protected Pubsub.Projects.Subscriptions.Create(java.lang.String name,
                                    Subscription content)

Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Create a request for the method "subscriptions.create". 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 - 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 Subscription

Since:

1.13

Method Detail

set$Xgafv

public Pubsub.Projects.Subscriptions.Create set$Xgafv(java.lang.String $Xgafv)

Description copied from class: PubsubRequest

V1 error format.

Overrides:

set$Xgafv in class PubsubRequest<Subscription>

setAccessToken

public Pubsub.Projects.Subscriptions.Create setAccessToken(java.lang.String accessToken)

Description copied from class: PubsubRequest

OAuth access token.

Overrides:

setAccessToken in class PubsubRequest<Subscription>

setAlt

public Pubsub.Projects.Subscriptions.Create setAlt(java.lang.String alt)

Description copied from class: PubsubRequest

Data format for response.

Overrides:

setAlt in class PubsubRequest<Subscription>

setBearerToken

public Pubsub.Projects.Subscriptions.Create setBearerToken(java.lang.String bearerToken)

Description copied from class: PubsubRequest

OAuth bearer token.

Overrides:

setBearerToken in class PubsubRequest<Subscription>

setCallback

public Pubsub.Projects.Subscriptions.Create setCallback(java.lang.String callback)

Description copied from class: PubsubRequest

JSONP

Overrides:

setCallback in class PubsubRequest<Subscription>

setFields

public Pubsub.Projects.Subscriptions.Create setFields(java.lang.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.Create setKey(java.lang.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.Create setOauthToken(java.lang.String oauthToken)

Description copied from class: PubsubRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PubsubRequest<Subscription>

setPp

public Pubsub.Projects.Subscriptions.Create setPp(java.lang.Boolean pp)

Description copied from class: PubsubRequest

Pretty-print response.

Overrides:

setPp in class PubsubRequest<Subscription>

setPrettyPrint

public Pubsub.Projects.Subscriptions.Create setPrettyPrint(java.lang.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.Create setQuotaUser(java.lang.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.Create setUploadType(java.lang.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.Create setUploadProtocol(java.lang.String uploadProtocol)

Description copied from class: PubsubRequest

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

Overrides:

setUploadProtocol in class PubsubRequest<Subscription>

getName

public java.lang.String getName()

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.Create setName(java.lang.String name)

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.Create set(java.lang.String parameterName,
                                       java.lang.Object value)

Overrides:

set in class PubsubRequest<Subscription>