Class: Google::Cloud::SecretManager::V1::Secret

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/secretmanager/v1/resources.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.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the Secret was created.

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 71

class Secret
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String

Returns Optional. Etag of the currently stored Secret.

Returns:

  • (::String) —

    Optional. Etag of the currently stored Secret.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 71

class Secret
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#expire_time ⇒ ::Google::Protobuf::Timestamp

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

Returns:

  • (::Google::Protobuf::Timestamp) —

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



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 71

class Secret
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,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: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

No more than 64 labels can be assigned to a given resource.

Returns:

  • (::Google::Protobuf::Map{::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: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,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: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

    No more than 64 labels can be assigned to a given resource.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 71

class Secret
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the Secret in the format projects/*/secrets/*.

Returns:

  • (::String) —

    Output only. The resource name of the Secret in the format projects/*/secrets/*.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 71

class Secret
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#replication ⇒ ::Google::Cloud::SecretManager::V1::Replication

Returns Required. Immutable. The replication policy of the secret data attached to the Secret.

The replication policy cannot be changed after the Secret has been created.

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 71

class Secret
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#rotation ⇒ ::Google::Cloud::SecretManager::V1::Rotation

Returns Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 71

class Secret
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#topics ⇒ ::Array<::Google::Cloud::SecretManager::V1::Topic>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::SecretManager::V1::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.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 71

class Secret
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ttl ⇒ ::Google::Protobuf::Duration

Returns Input only. The TTL for the Secret.

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 71

class Secret
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end