Class: Google::Cloud::Security::PrivateCA::V1::Certificate

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/security/privateca/v1/resources.rb

Overview

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

Defined Under Namespace

Classes: LabelsEntry, RevocationDetails

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_description ⇒ ::Google::Cloud::Security::PrivateCA::V1::CertificateDescription (readonly)

Returns Output only. A structured description of the issued X.509 certificate.

Returns:



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#certificate_template ⇒ ::String

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

Returns:

  • (::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.



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#config ⇒ ::Google::Cloud::Security::PrivateCA::V1::CertificateConfig

Returns Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

Note: The following fields are mutually exclusive: config, pem_csr. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Security::PrivateCA::V1::CertificateConfig) —

    Immutable. A description of the certificate and key that does not require X.509 or ASN.1.

    Note: The following fields are mutually exclusive: config, pem_csr. If a field in that set is populated, all other fields in the set will automatically be cleared.



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

Returns Output only. The time at which this Certificate was created.

Returns:



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#issuer_certificate_authority ⇒ ::String (readonly)

Returns Output only. The resource name of the issuing CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.

Returns:

  • (::String) —

    Output only. The resource name of the issuing CertificateAuthority in the format projects/*/locations/*/caPools/*/certificateAuthorities/*.



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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 Optional. Labels with user-defined metadata.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. Labels with user-defined metadata.



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#lifetime ⇒ ::Google::Protobuf::Duration

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

Returns:

  • (::Google::Protobuf::Duration) —

    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.



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

Returns Identifier. The resource name for this Certificate in the format projects/*/locations/*/caPools/*/certificates/*.

Returns:

  • (::String) —

    Identifier. The resource name for this Certificate in the format projects/*/locations/*/caPools/*/certificates/*.



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#pem_certificate ⇒ ::String (readonly)

Returns Output only. The pem-encoded, signed X.509 certificate.

Returns:

  • (::String) —

    Output only. The pem-encoded, signed X.509 certificate.



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#pem_certificate_chain ⇒ ::Array<::String> (readonly)

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

Returns:

  • (::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.



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#pem_csr ⇒ ::String

Returns Immutable. A pem-encoded X.509 certificate signing request (CSR).

Note: The following fields are mutually exclusive: pem_csr, config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Immutable. A pem-encoded X.509 certificate signing request (CSR).

    Note: The following fields are mutually exclusive: pem_csr, config. If a field in that set is populated, all other fields in the set will automatically be cleared.



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#revocation_details ⇒ ::Google::Cloud::Security::PrivateCA::V1::Certificate::RevocationDetails (readonly)

Returns Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.

Returns:



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

#subject_mode ⇒ ::Google::Cloud::Security::PrivateCA::V1::SubjectRequestMode

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

Returns:



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

Returns Output only. The time at which this Certificate was updated.

Returns:



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/security/privateca/v1/resources.rb', line 783

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

  # Describes fields that are relavent to the revocation of a
  # {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate}.
  # @!attribute [rw] revocation_state
  #   @return [::Google::Cloud::Security::PrivateCA::V1::RevocationReason]
  #     Indicates why a
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  # @!attribute [rw] revocation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this
  #     {::Google::Cloud::Security::PrivateCA::V1::Certificate Certificate} was
  #     revoked.
  class RevocationDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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