Class: Google::Apis::GmailV1::CseKeyPair

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

Overview

A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages.

  • Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CseKeyPair

Returns a new instance of CseKeyPair.



186
187
188
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 186

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

Instance Attribute Details

#disable_time ⇒ String

Output only. If a key pair is set to DISABLED, the time that the key pair's state changed from ENABLED to DISABLED. This field is present only when the key pair is in state DISABLED. Corresponds to the JSON property disableTime

Returns:

  • (String) 


150
151
152
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 150

def disable_time
  @disable_time
end

#enablement_state ⇒ String

Output only. The current state of the key pair. Corresponds to the JSON property enablementState

Returns:

  • (String) 


155
156
157
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 155

def enablement_state
  @enablement_state
end

#key_pair_id ⇒ String

Output only. The immutable ID for the client-side encryption S/MIME key pair. Corresponds to the JSON property keyPairId

Returns:

  • (String) 


160
161
162
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 160

def key_pair_id
  @key_pair_id
end

#pem ⇒ String

Output only. The public key and its certificate chain, in PEM format. Corresponds to the JSON property pem

Returns:

  • (String) 


166
167
168
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 166

def pem
  @pem
end

#pkcs7 ⇒ String

Input only. The public key and its certificate chain. The chain must be in PKCS#7 format and use PEM encoding and ASCII armor. Corresponds to the JSON property pkcs7

Returns:

  • (String) 


173
174
175
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 173

def pkcs7
  @pkcs7
end

#private_key_metadata ⇒ Array<Google::Apis::GmailV1::CsePrivateKeyMetadata>

Metadata for instances of this key pair's private key. Corresponds to the JSON property privateKeyMetadata

Returns:



178
179
180
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 178

def private_key_metadata
  @private_key_metadata
end

#subject_email_addresses ⇒ Array<String>

Output only. The email address identities that are specified on the leaf certificate. Corresponds to the JSON property subjectEmailAddresses

Returns:

  • (Array<String>) 


184
185
186
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 184

def subject_email_addresses
  @subject_email_addresses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



191
192
193
194
195
196
197
198
199
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 191

def update!(**args)
  @disable_time = args[:disable_time] if args.key?(:disable_time)
  @enablement_state = args[:enablement_state] if args.key?(:enablement_state)
  @key_pair_id = args[:key_pair_id] if args.key?(:key_pair_id)
  @pem = args[:pem] if args.key?(:pem)
  @pkcs7 = args[:pkcs7] if args.key?(:pkcs7)
  @private_key_metadata = args[:private_key_metadata] if args.key?(:private_key_metadata)
  @subject_email_addresses = args[:subject_email_addresses] if args.key?(:subject_email_addresses)
end