Class: Google::Apis::PubsubV1::UpdateSnapshotRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/pubsub_v1/classes.rb,
lib/google/apis/pubsub_v1/representations.rb,
lib/google/apis/pubsub_v1/representations.rb

Overview

Request for the UpdateSnapshot method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UpdateSnapshotRequest

Returns a new instance of UpdateSnapshotRequest.



1986
1987
1988
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1986

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#snapshot ⇒ Google::Apis::PubsubV1::Snapshot

A snapshot resource. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Corresponds to the JSON property snapshot

Returns:



1978
1979
1980
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1978

def snapshot
  @snapshot
end

#update_mask ⇒ String

Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty. Corresponds to the JSON property updateMask

Returns:

  • (String) 


1984
1985
1986
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1984

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1991
1992
1993
1994
 
# File 'lib/google/apis/pubsub_v1/classes.rb', line 1991

def update!(**args)
  @snapshot = args[:snapshot] if args.key?(:snapshot)
  @update_mask = args[:update_mask] if args.key?(:update_mask)
end