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

Inherits:

Object

• Object
• Google::Apis::PubsubV1::UpdateSnapshotRequest

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.

BETA: This feature is part of a beta release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Instance Attribute Summary

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

  A snapshot resource.

• #update_mask ⇒ String

  Indicates which fields in the provided snapshot to update.

Instance Method Summary

• #initialize(**args) ⇒ UpdateSnapshotRequest constructor

  A new instance of UpdateSnapshotRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

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

# File 'generated/google/apis/pubsub_v1/classes.rb', line 1020

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.

BETA: This feature is part of a beta release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. Corresponds to the JSON property snapshot

Returns:

• (Google::Apis::PubsubV1::Snapshot)

# File 'generated/google/apis/pubsub_v1/classes.rb', line 1012

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)

# File 'generated/google/apis/pubsub_v1/classes.rb', line 1018

def update_mask
  @update_mask
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/pubsub_v1/classes.rb', line 1025

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