Class: Google::Apis::SecretmanagerV1::Secret

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

Overview

A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Secret

Returns a new instance of Secret.



867
868
869
 
# File 'lib/google/apis/secretmanager_v1/classes.rb', line 867

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

Instance Attribute Details

#create_time ⇒ String

Output only. The time at which the Secret was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


815
816
817
 
# File 'lib/google/apis/secretmanager_v1/classes.rb', line 815

def create_time
  @create_time
end

#etag ⇒ String

Optional. Etag of the currently stored Secret. Corresponds to the JSON property etag

Returns:

  • (String) 


820
821
822
 
# File 'lib/google/apis/secretmanager_v1/classes.rb', line 820

def etag
  @etag
end

#expire_time ⇒ String

Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input. Corresponds to the JSON property expireTime

Returns:

  • (String) 


826
827
828
 
# File 'lib/google/apis/secretmanager_v1/classes.rb', line 826

def expire_time
  @expire_time
end

#labels ⇒ Hash<String,String>

The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \pLl\pLo0,62 Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\pLl\p Lo\pN_-]0,63`No more than 64 labels can be assigned to a given resource. Corresponds to the JSON propertylabels`

Returns:

  • (Hash<String,String>) 


836
837
838
 
# File 'lib/google/apis/secretmanager_v1/classes.rb', line 836

def labels
  @labels
end

#name ⇒ String

Output only. The resource name of the Secret in the format projects/*/secrets/ *. Corresponds to the JSON property name

Returns:

  • (String) 


842
843
844
 
# File 'lib/google/apis/secretmanager_v1/classes.rb', line 842

def name
  @name
end

#replication ⇒ Google::Apis::SecretmanagerV1::Replication

A policy that defines the replication and encryption configuration of data. Corresponds to the JSON property replication

Returns:



847
848
849
 
# File 'lib/google/apis/secretmanager_v1/classes.rb', line 847

def replication
  @replication
end

#rotation ⇒ Google::Apis::SecretmanagerV1::Rotation

The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. Corresponds to the JSON property rotation

Returns:



854
855
856
 
# File 'lib/google/apis/secretmanager_v1/classes.rb', line 854

def rotation
  @rotation
end

#topics ⇒ Array<Google::Apis::SecretmanagerV1::Topic>

Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. Corresponds to the JSON property topics

Returns:



860
861
862
 
# File 'lib/google/apis/secretmanager_v1/classes.rb', line 860

def topics
  @topics
end

#ttl ⇒ String

Input only. The TTL for the Secret. Corresponds to the JSON property ttl

Returns:

  • (String) 


865
866
867
 
# File 'lib/google/apis/secretmanager_v1/classes.rb', line 865

def ttl
  @ttl
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



872
873
874
875
876
877
878
879
880
881
882
 
# File 'lib/google/apis/secretmanager_v1/classes.rb', line 872

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @etag = args[:etag] if args.key?(:etag)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @replication = args[:replication] if args.key?(:replication)
  @rotation = args[:rotation] if args.key?(:rotation)
  @topics = args[:topics] if args.key?(:topics)
  @ttl = args[:ttl] if args.key?(:ttl)
end