Class: Google::Apis::ClouddeployV1::Rollout

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

Overview

A Rollout resource in the Google Cloud Deploy API. A Rollout contains information around a specific deployment to a Target.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Rollout

Returns a new instance of Rollout.



1996
1997
1998
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1996

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


1891
1892
1893
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1891

def annotations
  @annotations
end

#approval_state ⇒ String

Output only. Approval state of the Rollout. Corresponds to the JSON property approvalState

Returns:

  • (String) 


1896
1897
1898
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1896

def approval_state
  @approval_state
end

#approve_time ⇒ String

Output only. Time at which the Rollout was approved. Corresponds to the JSON property approveTime

Returns:

  • (String) 


1901
1902
1903
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1901

def approve_time
  @approve_time
end

#create_time ⇒ String

Output only. Time at which the Rollout was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1906
1907
1908
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1906

def create_time
  @create_time
end

#deploy_end_time ⇒ String

Output only. Time at which the Rollout finished deploying. Corresponds to the JSON property deployEndTime

Returns:

  • (String) 


1911
1912
1913
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1911

def deploy_end_time
  @deploy_end_time
end

#deploy_failure_cause ⇒ String

Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress. Corresponds to the JSON property deployFailureCause

Returns:

  • (String) 


1917
1918
1919
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1917

def deploy_failure_cause
  @deploy_failure_cause
end

#deploy_start_time ⇒ String

Output only. Time at which the Rollout started deploying. Corresponds to the JSON property deployStartTime

Returns:

  • (String) 


1922
1923
1924
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1922

def deploy_start_time
  @deploy_start_time
end

#deploying_build ⇒ String

Output only. The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/project/locations/location/ builds/build`. Corresponds to the JSON propertydeployingBuild`

Returns:

  • (String) 


1929
1930
1931
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1929

def deploying_build
  @deploying_build
end

#description ⇒ String

Description of the Rollout for user purposes. Max length is 255 characters. Corresponds to the JSON property description

Returns:

  • (String) 


1934
1935
1936
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1934

def description
  @description
end

#enqueue_time ⇒ String

Output only. Time at which the Rollout was enqueued. Corresponds to the JSON property enqueueTime

Returns:

  • (String) 


1939
1940
1941
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1939

def enqueue_time
  @enqueue_time
end

#etag ⇒ String

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up- to-date value before proceeding. Corresponds to the JSON property etag

Returns:

  • (String) 


1946
1947
1948
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1946

def etag
  @etag
end

#failure_reason ⇒ String

Output only. Additional information about the rollout failure, if available. Corresponds to the JSON property failureReason

Returns:

  • (String) 


1951
1952
1953
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1951

def failure_reason
  @failure_reason
end

#labels ⇒ Hash<String,String>

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1962
1963
1964
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1962

def labels
  @labels
end

#metadata ⇒ Google::Apis::ClouddeployV1::Metadata

Metadata includes information associated with a Rollout. Corresponds to the JSON property metadata

Returns:



1967
1968
1969
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1967

def metadata
  @metadata
end

#name ⇒ String

Optional. Name of the Rollout. Format is projects/project/ locations/ location/deliveryPipelines/deliveryPipeline/ releases/release/rollouts/a- z0,62. Corresponds to the JSON property name

Returns:

  • (String) 


1974
1975
1976
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1974

def name
  @name
end

#phases ⇒ Array<Google::Apis::ClouddeployV1::Phase>

Output only. The phases that represent the workflows of this Rollout. Corresponds to the JSON property phases

Returns:



1979
1980
1981
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1979

def phases
  @phases
end

#state ⇒ String

Output only. Current state of the Rollout. Corresponds to the JSON property state

Returns:

  • (String) 


1984
1985
1986
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1984

def state
  @state
end

#target_id ⇒ String

Required. The ID of Target to which this Rollout is deploying. Corresponds to the JSON property targetId

Returns:

  • (String) 


1989
1990
1991
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1989

def target_id
  @target_id
end

#uid ⇒ String

Output only. Unique identifier of the Rollout. Corresponds to the JSON property uid

Returns:

  • (String) 


1994
1995
1996
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 1994

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/google/apis/clouddeploy_v1/classes.rb', line 2001

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @approval_state = args[:approval_state] if args.key?(:approval_state)
  @approve_time = args[:approve_time] if args.key?(:approve_time)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deploy_end_time = args[:deploy_end_time] if args.key?(:deploy_end_time)
  @deploy_failure_cause = args[:deploy_failure_cause] if args.key?(:deploy_failure_cause)
  @deploy_start_time = args[:deploy_start_time] if args.key?(:deploy_start_time)
  @deploying_build = args[:deploying_build] if args.key?(:deploying_build)
  @description = args[:description] if args.key?(:description)
  @enqueue_time = args[:enqueue_time] if args.key?(:enqueue_time)
  @etag = args[:etag] if args.key?(:etag)
  @failure_reason = args[:failure_reason] if args.key?(:failure_reason)
  @labels = args[:labels] if args.key?(:labels)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @phases = args[:phases] if args.key?(:phases)
  @state = args[:state] if args.key?(:state)
  @target_id = args[:target_id] if args.key?(:target_id)
  @uid = args[:uid] if args.key?(:uid)
end