Class: Google::Apis::StoragetransferV1::EventStream

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

Overview

Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EventStream

Returns a new instance of EventStream.



475
476
477
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 475

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

Instance Attribute Details

#event_stream_expiration_timeString

Specifies the data and time at which Storage Transfer Service stops listening for events from this stream. After this time, any transfers in progress will complete, but no new transfers are initiated. Corresponds to the JSON property eventStreamExpirationTime

Returns:

  • (String)


459
460
461
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 459

def event_stream_expiration_time
  @event_stream_expiration_time
end

#event_stream_start_timeString

Specifies the date and time that Storage Transfer Service starts listening for events from this stream. If no start time is specified or start time is in the past, Storage Transfer Service starts listening immediately. Corresponds to the JSON property eventStreamStartTime

Returns:

  • (String)


466
467
468
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 466

def event_stream_start_time
  @event_stream_start_time
end

#nameString

Required. Specifies a unique name of the resource such as AWS SQS ARN in the form 'arn:aws:sqs:region:account_id:queue_name', or Pub/Sub subscription resource name in the form 'projects/project/subscriptions/sub'. Corresponds to the JSON property name

Returns:

  • (String)


473
474
475
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 473

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



480
481
482
483
484
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 480

def update!(**args)
  @event_stream_expiration_time = args[:event_stream_expiration_time] if args.key?(:event_stream_expiration_time)
  @event_stream_start_time = args[:event_stream_start_time] if args.key?(:event_stream_start_time)
  @name = args[:name] if args.key?(:name)
end