Pubsub.Projects.Subscriptions.Create (Cloud Pub/Sub API v1-rev20210322-1.31.0)

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.Create

All Implemented Interfaces:

Cloneable, Map<String,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
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  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 Create(String name, Subscription content)
Creates a subscription to a given topic.

Constructors
Modifier	Constructor and Description
`protected`	`Create(String name, Subscription content)` Creates a subscription to a given topic.

Method Summary

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

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.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
  - Create
```
protected Create(String name,
                 Subscription content)
```
    Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). 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, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request. 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 - 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 Subscription
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Pubsub.Projects.Subscriptions.Create set$Xgafv(String $Xgafv)
```
    Description copied from class: PubsubRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class PubsubRequest<Subscription>
  - setAccessToken
```
public Pubsub.Projects.Subscriptions.Create setAccessToken(String accessToken)
```
    Description copied from class: PubsubRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class PubsubRequest<Subscription>
  - setAlt
```
public Pubsub.Projects.Subscriptions.Create setAlt(String alt)
```
    Description copied from class: PubsubRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class PubsubRequest<Subscription>
  - setCallback
```
public Pubsub.Projects.Subscriptions.Create setCallback(String callback)
```
    Description copied from class: PubsubRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class PubsubRequest<Subscription>
  - setFields
```
public Pubsub.Projects.Subscriptions.Create 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.Create 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.Create 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.Create 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.Create 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.Create 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.Create 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.Create 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.Create set(String parameterName,
                                                Object value)
```
    Overrides:
    
    set in class PubsubRequest<Subscription>

Class Pubsub.Projects.Subscriptions.Create

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Create

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

set