Class: Google::Apis::RedisV1beta1::OperationMetadata

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

Overview

This operation metadata represents the state of operations that may have happened or are happening on the instance. All fields are output only. It is returned as content of the google.longrunning.Operation.metadata field. The google.longrunning.Operation.name field will be of the form projects/project_id/locations/location_id/operations/operation_idand the name for a `ListOperations` request will be of the form `projects/`project_id`/locations/`location_id On a ListOperations request where location_id is "-", all regions available to the project_id are queried and the results aggregated. If a location is not available, a dummy google.longrunning.Operation entry will be included in the operations field of the response, with the name field set to a value of the form projects/project_id/locations/location_id/operations/- and the done field will be set and the result.error field set with the code field set to google.rpc.Code.DEADLINE_EXCEEDED and the message field set to location unavailable for ListOperations. The Operation metadata` field will not be set for such a dummy operation.

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

Returns a new instance of OperationMetadata



578
579
580
 
# File 'generated/google/apis/redis_v1beta1/classes.rb', line 578

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

Instance Attribute Details

#create_time ⇒ String

Output only. The time the operation was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


546
547
548
 
# File 'generated/google/apis/redis_v1beta1/classes.rb', line 546

def create_time
  @create_time
end

#detail ⇒ String

Output only. Detailed operation progress, if available. Corresponds to the JSON property detail

Returns:

  • (String) 


551
552
553
 
# File 'generated/google/apis/redis_v1beta1/classes.rb', line 551

def detail
  @detail
end

#end_time ⇒ String

Output only. The time the operation was completed. Corresponds to the JSON property endTime

Returns:

  • (String) 


556
557
558
 
# File 'generated/google/apis/redis_v1beta1/classes.rb', line 556

def end_time
  @end_time
end

#operation_type ⇒ String

Output only. The operation type. Corresponds to the JSON property operationType

Returns:

  • (String) 


561
562
563
 
# File 'generated/google/apis/redis_v1beta1/classes.rb', line 561

def operation_type
  @operation_type
end

#start_time ⇒ String

Output only. The time the operation was started. Corresponds to the JSON property startTime

Returns:

  • (String) 


566
567
568
 
# File 'generated/google/apis/redis_v1beta1/classes.rb', line 566

def start_time
  @start_time
end

#state ⇒ String

Output only. The current state of the operation. Corresponds to the JSON property state

Returns:

  • (String) 


571
572
573
 
# File 'generated/google/apis/redis_v1beta1/classes.rb', line 571

def state
  @state
end

#target ⇒ String

Output only. Server-defined resource path for the target of the operation. Corresponds to the JSON property target

Returns:

  • (String) 


576
577
578
 
# File 'generated/google/apis/redis_v1beta1/classes.rb', line 576

def target
  @target
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



583
584
585
586
587
588
589
590
591
 
# File 'generated/google/apis/redis_v1beta1/classes.rb', line 583

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @detail = args[:detail] if args.key?(:detail)
  @end_time = args[:end_time] if args.key?(:end_time)
  @operation_type = args[:operation_type] if args.key?(:operation_type)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @target = args[:target] if args.key?(:target)
end