Class: Google::Apis::StorageV1::Notification

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

Overview

A subscription to receive Google PubSub notifications.

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) ⇒ Notification

Returns a new instance of Notification



854
855
856
 
# File 'generated/google/apis/storage_v1/classes.rb', line 854

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

Instance Attribute Details

#custom_attributes ⇒ Hash<String,String>

An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription. Corresponds to the JSON property custom_attributes

Returns:

  • (Hash<String,String>) 


808
809
810
 
# File 'generated/google/apis/storage_v1/classes.rb', line 808

def custom_attributes
  @custom_attributes
end

#etag ⇒ String

HTTP 1.1 Entity tag for this subscription notification. Corresponds to the JSON property etag

Returns:

  • (String) 


813
814
815
 
# File 'generated/google/apis/storage_v1/classes.rb', line 813

def etag
  @etag
end

#event_types ⇒ Array<String>

If present, only send notifications about listed event types. If empty, sent notifications for all event types. Corresponds to the JSON property event_types

Returns:

  • (Array<String>) 


819
820
821
 
# File 'generated/google/apis/storage_v1/classes.rb', line 819

def event_types
  @event_types
end

#id ⇒ String

The ID of the notification. Corresponds to the JSON property id

Returns:

  • (String) 


824
825
826
 
# File 'generated/google/apis/storage_v1/classes.rb', line 824

def id
  @id
end

#kind ⇒ String

The kind of item this is. For notifications, this is always storage# notification. Corresponds to the JSON property kind

Returns:

  • (String) 


830
831
832
 
# File 'generated/google/apis/storage_v1/classes.rb', line 830

def kind
  @kind
end

#object_name_prefix ⇒ String

If present, only apply this notification configuration to object names that begin with this prefix. Corresponds to the JSON property object_name_prefix

Returns:

  • (String) 


836
837
838
 
# File 'generated/google/apis/storage_v1/classes.rb', line 836

def object_name_prefix
  @object_name_prefix
end

#payload_format ⇒ String

The desired content of the Payload. Corresponds to the JSON property payload_format

Returns:

  • (String) 


841
842
843
 
# File 'generated/google/apis/storage_v1/classes.rb', line 841

def payload_format
  @payload_format
end

#self_link ⇒ String

The canonical URL of this notification. Corresponds to the JSON property selfLink

Returns:

  • (String) 


846
847
848
 
# File 'generated/google/apis/storage_v1/classes.rb', line 846

def self_link
  @self_link
end

#topic ⇒ String

The Cloud PubSub topic to which this subscription publishes. Formatted as: '// pubsub.googleapis.com/projects/project-identifier/topics/my-topic' Corresponds to the JSON property topic

Returns:

  • (String) 


852
853
854
 
# File 'generated/google/apis/storage_v1/classes.rb', line 852

def topic
  @topic
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



859
860
861
862
863
864
865
866
867
868
869
 
# File 'generated/google/apis/storage_v1/classes.rb', line 859

def update!(**args)
  @custom_attributes = args[:custom_attributes] if args.key?(:custom_attributes)
  @etag = args[:etag] if args.key?(:etag)
  @event_types = args[:event_types] if args.key?(:event_types)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @object_name_prefix = args[:object_name_prefix] if args.key?(:object_name_prefix)
  @payload_format = args[:payload_format] if args.key?(:payload_format)
  @self_link = args[:self_link] if args.key?(:self_link)
  @topic = args[:topic] if args.key?(:topic)
end