target.apidocs.com.google.api.services.pubsub.model.CreateSnapshotRequest.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-pubsub Show documentation

There is a newer version: v1-rev20240730-2.0.0

Show newest version







CreateSnapshotRequest (Cloud Pub/Sub API v1-rev20240918-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.pubsub.model
Class CreateSnapshotRequest



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.pubsub.model.CreateSnapshotRequest













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class CreateSnapshotRequest
extends com.google.api.client.json.GenericJson
Request for the `CreateSnapshot` method.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












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>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


CreateSnapshotRequest() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CreateSnapshotRequest
clone() 


Map<String,String>
getLabels()
Optional.



String
getSubscription()
Required.



CreateSnapshotRequest
set(String fieldName,
   Object value) 


CreateSnapshotRequest
setLabels(Map<String,String> labels)
Optional.



CreateSnapshotRequest
setSubscription(String subscription)
Required.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





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





CreateSnapshotRequest
public CreateSnapshotRequest()









Method Detail





getLabels
public Map<String,String> getLabels()
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).

Returns:
value or null for none








setLabels
public CreateSnapshotRequest setLabels(Map<String,String> labels)
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).

Parameters:
labels - labels or null for none








getSubscription
public String getSubscription()
Required. The subscription whose backlog the snapshot retains. Specifically, the created
 snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely,
 this is defined as the messages in the subscription's backlog that are unacknowledged upon the
 successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published
 to the subscription's topic following the successful completion of the CreateSnapshot request.
 Format is `projects/{project}/subscriptions/{sub}`.

Returns:
value or null for none








setSubscription
public CreateSnapshotRequest setSubscription(String subscription)
Required. The subscription whose backlog the snapshot retains. Specifically, the created
 snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely,
 this is defined as the messages in the subscription's backlog that are unacknowledged upon the
 successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published
 to the subscription's topic following the successful completion of the CreateSnapshot request.
 Format is `projects/{project}/subscriptions/{sub}`.

Parameters:
subscription - subscription or null for none








set
public CreateSnapshotRequest set(String fieldName,
                                 Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public CreateSnapshotRequest clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`CreateSnapshotRequest`	`clone()`
`Map<String,String>`	`getLabels()` Optional.
`String`	`getSubscription()` Required.
`CreateSnapshotRequest`	`set(String fieldName, Object value)`
`CreateSnapshotRequest`	`setLabels(Map<String,String> labels)` Optional.
`CreateSnapshotRequest`	`setSubscription(String subscription)` Required.