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

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

Overview

Request for the UpdateSnapshot method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UpdateSnapshotRequest

Returns a new instance of UpdateSnapshotRequest



1127
1128
1129
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1127

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:



1119
1120
1121
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1119

def snapshot
  @snapshot
end

#update_mask ⇒ String

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

Returns:

  • (String) 


1125
1126
1127
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1125

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1132
1133
1134
1135
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 1132

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