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.



1302
1303
1304
# File 'generated/google/apis/storage_v1/classes.rb', line 1302

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

Instance Attribute Details

#custom_attributesHash<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>)


1256
1257
1258
# File 'generated/google/apis/storage_v1/classes.rb', line 1256

def custom_attributes
  @custom_attributes
end

#etagString

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

Returns:

  • (String)


1261
1262
1263
# File 'generated/google/apis/storage_v1/classes.rb', line 1261

def etag
  @etag
end

#event_typesArray<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>)


1267
1268
1269
# File 'generated/google/apis/storage_v1/classes.rb', line 1267

def event_types
  @event_types
end

#idString

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

Returns:

  • (String)


1272
1273
1274
# File 'generated/google/apis/storage_v1/classes.rb', line 1272

def id
  @id
end

#kindString

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

Returns:

  • (String)


1278
1279
1280
# File 'generated/google/apis/storage_v1/classes.rb', line 1278

def kind
  @kind
end

#object_name_prefixString

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)


1284
1285
1286
# File 'generated/google/apis/storage_v1/classes.rb', line 1284

def object_name_prefix
  @object_name_prefix
end

#payload_formatString

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

Returns:

  • (String)


1289
1290
1291
# File 'generated/google/apis/storage_v1/classes.rb', line 1289

def payload_format
  @payload_format
end

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

Returns:

  • (String)


1294
1295
1296
# File 'generated/google/apis/storage_v1/classes.rb', line 1294

def self_link
  @self_link
end

#topicString

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)


1300
1301
1302
# File 'generated/google/apis/storage_v1/classes.rb', line 1300

def topic
  @topic
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
# File 'generated/google/apis/storage_v1/classes.rb', line 1307

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