Class: Google::Apis::PrivatecaV1::Certificate

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

Overview

A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Certificate

Returns a new instance of Certificate.



470
471
472
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 470

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

Instance Attribute Details

#certificate_description ⇒ Google::Apis::PrivatecaV1::CertificateDescription

A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. Corresponds to the JSON property certificateDescription

Returns:



391
392
393
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 391

def certificate_description
  @certificate_description
end

#certificate_template ⇒ String

Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format projects/*/locations/*/certificateTemplates/*. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. Corresponds to the JSON property certificateTemplate

Returns:

  • (String) 


400
401
402
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 400

def certificate_template
  @certificate_template
end

#config ⇒ Google::Apis::PrivatecaV1::CertificateConfig

A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. Corresponds to the JSON property config

Returns:



406
407
408
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 406

def config
  @config
end

#create_time ⇒ String

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

Returns:

  • (String) 


411
412
413
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 411

def create_time
  @create_time
end

#issuer_certificate_authority ⇒ String

Output only. The resource name of the issuing CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*. Corresponds to the JSON property issuerCertificateAuthority

Returns:

  • (String) 


417
418
419
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 417

def issuer_certificate_authority
  @issuer_certificate_authority
end

#labels ⇒ Hash<String,String>

Optional. Labels with user-defined metadata. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


422
423
424
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 422

def labels
  @labels
end

#lifetime ⇒ String

Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. Corresponds to the JSON property lifetime

Returns:

  • (String) 


430
431
432
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 430

def lifetime
  @lifetime
end

#name ⇒ String

Output only. The resource name for this Certificate in the format projects/*/ locations/*/caPools/*/certificates/*. Corresponds to the JSON property name

Returns:

  • (String) 


436
437
438
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 436

def name
  @name
end

#pem_certificate ⇒ String

Output only. The pem-encoded, signed X.509 certificate. Corresponds to the JSON property pemCertificate

Returns:

  • (String) 


441
442
443
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 441

def pem_certificate
  @pem_certificate
end

#pem_certificate_chain ⇒ Array<String>

Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. Corresponds to the JSON property pemCertificateChain

Returns:

  • (Array<String>) 


447
448
449
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 447

def pem_certificate_chain
  @pem_certificate_chain
end

#pem_csr ⇒ String

Immutable. A pem-encoded X.509 certificate signing request (CSR). Corresponds to the JSON property pemCsr

Returns:

  • (String) 


452
453
454
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 452

def pem_csr
  @pem_csr
end

#revocation_details ⇒ Google::Apis::PrivatecaV1::RevocationDetails

Describes fields that are relavent to the revocation of a Certificate. Corresponds to the JSON property revocationDetails

Returns:



457
458
459
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 457

def revocation_details
  @revocation_details
end

#subject_mode ⇒ String

Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the DEFAULT subject mode will be used. Corresponds to the JSON property subjectMode

Returns:

  • (String) 


463
464
465
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 463

def subject_mode
  @subject_mode
end

#update_time ⇒ String

Output only. The time at which this Certificate was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


468
469
470
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 468

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/google/apis/privateca_v1/classes.rb', line 475

def update!(**args)
  @certificate_description = args[:certificate_description] if args.key?(:certificate_description)
  @certificate_template = args[:certificate_template] if args.key?(:certificate_template)
  @config = args[:config] if args.key?(:config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @issuer_certificate_authority = args[:issuer_certificate_authority] if args.key?(:issuer_certificate_authority)
  @labels = args[:labels] if args.key?(:labels)
  @lifetime = args[:lifetime] if args.key?(:lifetime)
  @name = args[:name] if args.key?(:name)
  @pem_certificate = args[:pem_certificate] if args.key?(:pem_certificate)
  @pem_certificate_chain = args[:pem_certificate_chain] if args.key?(:pem_certificate_chain)
  @pem_csr = args[:pem_csr] if args.key?(:pem_csr)
  @revocation_details = args[:revocation_details] if args.key?(:revocation_details)
  @subject_mode = args[:subject_mode] if args.key?(:subject_mode)
  @update_time = args[:update_time] if args.key?(:update_time)
end