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.



193
194
195
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 193

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) 


157
158
159
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 157

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) 


162
163
164
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 162

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) 


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

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) 


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

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) 


180
181
182
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 180

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:



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

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


191
192
193
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 191

def subject_email_addresses
  @subject_email_addresses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



198
199
200
201
202
203
204
205
206
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 198

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