Class: Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate

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

Overview

Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so.

Defined Under Namespace

Modules: State Classes: AuthorizationAttemptInfo, ProvisioningIssue

Instance Attribute Summary collapse

Instance Attribute Details

#authorization_attempt_info ⇒ ::Array<::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo> (readonly)

Returns Output only. Detailed state of the latest authorization attempt for each domain specified for managed certificate resource.

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 521

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

  # Information about issues with provisioning a Managed Certificate.
  # @!attribute [r] reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::ProvisioningIssue::Reason]
  #     Output only. Reason for provisioning failures.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation about the issue. Provided to
  #     help address the configuration issues. Not guaranteed to be stable. For
  #     programmatic access use Reason enum.
  class ProvisioningIssue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Reason for provisioning failures.
    module Reason
      # Reason is unspecified.
      REASON_UNSPECIFIED = 0

      # Certificate provisioning failed due to an issue with one or more of
      # the domains on the certificate.
      # For details of which domains failed, consult the
      # `authorization_attempt_info` field.
      AUTHORIZATION_ISSUE = 1

      # Exceeded Certificate Authority quotas or internal rate limits of the
      # system. Provisioning may take longer to complete.
      RATE_LIMITED = 2
    end
  end

  # State of the latest attempt to authorize a domain for certificate
  # issuance.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Domain name of the authorization attempt.
  # @!attribute [r] state
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::State]
  #     Output only. State of the domain for managed certificate issuance.
  # @!attribute [r] failure_reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::FailureReason]
  #     Output only. Reason for failure of the authorization attempt for the
  #     domain.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation for reaching the state.
  #     Provided to help address the configuration issues. Not guaranteed to be
  #     stable. For programmatic access use FailureReason enum.
  class AuthorizationAttemptInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of the domain for managed certificate issuance.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Certificate provisioning for this domain is under way. Google Cloud
      # will attempt to authorize the domain.
      AUTHORIZING = 1

      # A managed certificate can be provisioned, no issues for this domain.
      AUTHORIZED = 6

      # Attempt to authorize the domain failed. This prevents the Managed
      # Certificate from being issued.
      # See `failure_reason` and `details` fields for more information.
      FAILED = 7
    end

    # Reason for failure of the authorization attempt for the domain.
    module FailureReason
      # FailureReason is unspecified.
      FAILURE_REASON_UNSPECIFIED = 0

      # There was a problem with the user's DNS or load balancer
      # configuration for this domain.
      CONFIG = 1

      # Certificate issuance forbidden by an explicit CAA record for the
      # domain or a failure to check CAA records for the domain.
      CAA = 2

      # Reached a CA or internal rate-limit for the domain,
      # e.g. for certificates per top-level private domain.
      RATE_LIMITED = 3
    end
  end

  # State of the managed certificate resource.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # Certificate Manager attempts to provision or renew the certificate.
    # If the process takes longer than expected, consult the
    # `provisioning_issue` field.
    PROVISIONING = 1

    # Multiple certificate provisioning attempts failed and Certificate
    # Manager gave up. To try again, delete and create a new managed
    # Certificate resource.
    # For details see the `provisioning_issue` field.
    FAILED = 2

    # The certificate management is working, and a certificate has been
    # provisioned.
    ACTIVE = 3
  end
end

#dns_authorizations ⇒ ::Array<::String>

Returns Immutable. Authorizations that will be used for performing domain authorization.

Returns:

  • (::Array<::String>) —

    Immutable. Authorizations that will be used for performing domain authorization.



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 521

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

  # Information about issues with provisioning a Managed Certificate.
  # @!attribute [r] reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::ProvisioningIssue::Reason]
  #     Output only. Reason for provisioning failures.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation about the issue. Provided to
  #     help address the configuration issues. Not guaranteed to be stable. For
  #     programmatic access use Reason enum.
  class ProvisioningIssue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Reason for provisioning failures.
    module Reason
      # Reason is unspecified.
      REASON_UNSPECIFIED = 0

      # Certificate provisioning failed due to an issue with one or more of
      # the domains on the certificate.
      # For details of which domains failed, consult the
      # `authorization_attempt_info` field.
      AUTHORIZATION_ISSUE = 1

      # Exceeded Certificate Authority quotas or internal rate limits of the
      # system. Provisioning may take longer to complete.
      RATE_LIMITED = 2
    end
  end

  # State of the latest attempt to authorize a domain for certificate
  # issuance.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Domain name of the authorization attempt.
  # @!attribute [r] state
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::State]
  #     Output only. State of the domain for managed certificate issuance.
  # @!attribute [r] failure_reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::FailureReason]
  #     Output only. Reason for failure of the authorization attempt for the
  #     domain.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation for reaching the state.
  #     Provided to help address the configuration issues. Not guaranteed to be
  #     stable. For programmatic access use FailureReason enum.
  class AuthorizationAttemptInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of the domain for managed certificate issuance.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Certificate provisioning for this domain is under way. Google Cloud
      # will attempt to authorize the domain.
      AUTHORIZING = 1

      # A managed certificate can be provisioned, no issues for this domain.
      AUTHORIZED = 6

      # Attempt to authorize the domain failed. This prevents the Managed
      # Certificate from being issued.
      # See `failure_reason` and `details` fields for more information.
      FAILED = 7
    end

    # Reason for failure of the authorization attempt for the domain.
    module FailureReason
      # FailureReason is unspecified.
      FAILURE_REASON_UNSPECIFIED = 0

      # There was a problem with the user's DNS or load balancer
      # configuration for this domain.
      CONFIG = 1

      # Certificate issuance forbidden by an explicit CAA record for the
      # domain or a failure to check CAA records for the domain.
      CAA = 2

      # Reached a CA or internal rate-limit for the domain,
      # e.g. for certificates per top-level private domain.
      RATE_LIMITED = 3
    end
  end

  # State of the managed certificate resource.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # Certificate Manager attempts to provision or renew the certificate.
    # If the process takes longer than expected, consult the
    # `provisioning_issue` field.
    PROVISIONING = 1

    # Multiple certificate provisioning attempts failed and Certificate
    # Manager gave up. To try again, delete and create a new managed
    # Certificate resource.
    # For details see the `provisioning_issue` field.
    FAILED = 2

    # The certificate management is working, and a certificate has been
    # provisioned.
    ACTIVE = 3
  end
end

#domains ⇒ ::Array<::String>

Returns Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution.

Returns:

  • (::Array<::String>) —

    Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution.



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 521

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

  # Information about issues with provisioning a Managed Certificate.
  # @!attribute [r] reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::ProvisioningIssue::Reason]
  #     Output only. Reason for provisioning failures.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation about the issue. Provided to
  #     help address the configuration issues. Not guaranteed to be stable. For
  #     programmatic access use Reason enum.
  class ProvisioningIssue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Reason for provisioning failures.
    module Reason
      # Reason is unspecified.
      REASON_UNSPECIFIED = 0

      # Certificate provisioning failed due to an issue with one or more of
      # the domains on the certificate.
      # For details of which domains failed, consult the
      # `authorization_attempt_info` field.
      AUTHORIZATION_ISSUE = 1

      # Exceeded Certificate Authority quotas or internal rate limits of the
      # system. Provisioning may take longer to complete.
      RATE_LIMITED = 2
    end
  end

  # State of the latest attempt to authorize a domain for certificate
  # issuance.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Domain name of the authorization attempt.
  # @!attribute [r] state
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::State]
  #     Output only. State of the domain for managed certificate issuance.
  # @!attribute [r] failure_reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::FailureReason]
  #     Output only. Reason for failure of the authorization attempt for the
  #     domain.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation for reaching the state.
  #     Provided to help address the configuration issues. Not guaranteed to be
  #     stable. For programmatic access use FailureReason enum.
  class AuthorizationAttemptInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of the domain for managed certificate issuance.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Certificate provisioning for this domain is under way. Google Cloud
      # will attempt to authorize the domain.
      AUTHORIZING = 1

      # A managed certificate can be provisioned, no issues for this domain.
      AUTHORIZED = 6

      # Attempt to authorize the domain failed. This prevents the Managed
      # Certificate from being issued.
      # See `failure_reason` and `details` fields for more information.
      FAILED = 7
    end

    # Reason for failure of the authorization attempt for the domain.
    module FailureReason
      # FailureReason is unspecified.
      FAILURE_REASON_UNSPECIFIED = 0

      # There was a problem with the user's DNS or load balancer
      # configuration for this domain.
      CONFIG = 1

      # Certificate issuance forbidden by an explicit CAA record for the
      # domain or a failure to check CAA records for the domain.
      CAA = 2

      # Reached a CA or internal rate-limit for the domain,
      # e.g. for certificates per top-level private domain.
      RATE_LIMITED = 3
    end
  end

  # State of the managed certificate resource.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # Certificate Manager attempts to provision or renew the certificate.
    # If the process takes longer than expected, consult the
    # `provisioning_issue` field.
    PROVISIONING = 1

    # Multiple certificate provisioning attempts failed and Certificate
    # Manager gave up. To try again, delete and create a new managed
    # Certificate resource.
    # For details see the `provisioning_issue` field.
    FAILED = 2

    # The certificate management is working, and a certificate has been
    # provisioned.
    ACTIVE = 3
  end
end

#issuance_config ⇒ ::String

Returns Immutable. The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format projects/*/locations/*/certificateIssuanceConfigs/*. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa.

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 521

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

  # Information about issues with provisioning a Managed Certificate.
  # @!attribute [r] reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::ProvisioningIssue::Reason]
  #     Output only. Reason for provisioning failures.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation about the issue. Provided to
  #     help address the configuration issues. Not guaranteed to be stable. For
  #     programmatic access use Reason enum.
  class ProvisioningIssue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Reason for provisioning failures.
    module Reason
      # Reason is unspecified.
      REASON_UNSPECIFIED = 0

      # Certificate provisioning failed due to an issue with one or more of
      # the domains on the certificate.
      # For details of which domains failed, consult the
      # `authorization_attempt_info` field.
      AUTHORIZATION_ISSUE = 1

      # Exceeded Certificate Authority quotas or internal rate limits of the
      # system. Provisioning may take longer to complete.
      RATE_LIMITED = 2
    end
  end

  # State of the latest attempt to authorize a domain for certificate
  # issuance.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Domain name of the authorization attempt.
  # @!attribute [r] state
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::State]
  #     Output only. State of the domain for managed certificate issuance.
  # @!attribute [r] failure_reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::FailureReason]
  #     Output only. Reason for failure of the authorization attempt for the
  #     domain.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation for reaching the state.
  #     Provided to help address the configuration issues. Not guaranteed to be
  #     stable. For programmatic access use FailureReason enum.
  class AuthorizationAttemptInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of the domain for managed certificate issuance.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Certificate provisioning for this domain is under way. Google Cloud
      # will attempt to authorize the domain.
      AUTHORIZING = 1

      # A managed certificate can be provisioned, no issues for this domain.
      AUTHORIZED = 6

      # Attempt to authorize the domain failed. This prevents the Managed
      # Certificate from being issued.
      # See `failure_reason` and `details` fields for more information.
      FAILED = 7
    end

    # Reason for failure of the authorization attempt for the domain.
    module FailureReason
      # FailureReason is unspecified.
      FAILURE_REASON_UNSPECIFIED = 0

      # There was a problem with the user's DNS or load balancer
      # configuration for this domain.
      CONFIG = 1

      # Certificate issuance forbidden by an explicit CAA record for the
      # domain or a failure to check CAA records for the domain.
      CAA = 2

      # Reached a CA or internal rate-limit for the domain,
      # e.g. for certificates per top-level private domain.
      RATE_LIMITED = 3
    end
  end

  # State of the managed certificate resource.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # Certificate Manager attempts to provision or renew the certificate.
    # If the process takes longer than expected, consult the
    # `provisioning_issue` field.
    PROVISIONING = 1

    # Multiple certificate provisioning attempts failed and Certificate
    # Manager gave up. To try again, delete and create a new managed
    # Certificate resource.
    # For details see the `provisioning_issue` field.
    FAILED = 2

    # The certificate management is working, and a certificate has been
    # provisioned.
    ACTIVE = 3
  end
end

#provisioning_issue ⇒ ::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::ProvisioningIssue (readonly)

Returns Output only. Information about issues with provisioning a Managed Certificate.

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 521

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

  # Information about issues with provisioning a Managed Certificate.
  # @!attribute [r] reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::ProvisioningIssue::Reason]
  #     Output only. Reason for provisioning failures.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation about the issue. Provided to
  #     help address the configuration issues. Not guaranteed to be stable. For
  #     programmatic access use Reason enum.
  class ProvisioningIssue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Reason for provisioning failures.
    module Reason
      # Reason is unspecified.
      REASON_UNSPECIFIED = 0

      # Certificate provisioning failed due to an issue with one or more of
      # the domains on the certificate.
      # For details of which domains failed, consult the
      # `authorization_attempt_info` field.
      AUTHORIZATION_ISSUE = 1

      # Exceeded Certificate Authority quotas or internal rate limits of the
      # system. Provisioning may take longer to complete.
      RATE_LIMITED = 2
    end
  end

  # State of the latest attempt to authorize a domain for certificate
  # issuance.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Domain name of the authorization attempt.
  # @!attribute [r] state
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::State]
  #     Output only. State of the domain for managed certificate issuance.
  # @!attribute [r] failure_reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::FailureReason]
  #     Output only. Reason for failure of the authorization attempt for the
  #     domain.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation for reaching the state.
  #     Provided to help address the configuration issues. Not guaranteed to be
  #     stable. For programmatic access use FailureReason enum.
  class AuthorizationAttemptInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of the domain for managed certificate issuance.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Certificate provisioning for this domain is under way. Google Cloud
      # will attempt to authorize the domain.
      AUTHORIZING = 1

      # A managed certificate can be provisioned, no issues for this domain.
      AUTHORIZED = 6

      # Attempt to authorize the domain failed. This prevents the Managed
      # Certificate from being issued.
      # See `failure_reason` and `details` fields for more information.
      FAILED = 7
    end

    # Reason for failure of the authorization attempt for the domain.
    module FailureReason
      # FailureReason is unspecified.
      FAILURE_REASON_UNSPECIFIED = 0

      # There was a problem with the user's DNS or load balancer
      # configuration for this domain.
      CONFIG = 1

      # Certificate issuance forbidden by an explicit CAA record for the
      # domain or a failure to check CAA records for the domain.
      CAA = 2

      # Reached a CA or internal rate-limit for the domain,
      # e.g. for certificates per top-level private domain.
      RATE_LIMITED = 3
    end
  end

  # State of the managed certificate resource.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # Certificate Manager attempts to provision or renew the certificate.
    # If the process takes longer than expected, consult the
    # `provisioning_issue` field.
    PROVISIONING = 1

    # Multiple certificate provisioning attempts failed and Certificate
    # Manager gave up. To try again, delete and create a new managed
    # Certificate resource.
    # For details see the `provisioning_issue` field.
    FAILED = 2

    # The certificate management is working, and a certificate has been
    # provisioned.
    ACTIVE = 3
  end
end

#state ⇒ ::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::State (readonly)

Returns Output only. State of the managed certificate resource.

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 521

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

  # Information about issues with provisioning a Managed Certificate.
  # @!attribute [r] reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::ProvisioningIssue::Reason]
  #     Output only. Reason for provisioning failures.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation about the issue. Provided to
  #     help address the configuration issues. Not guaranteed to be stable. For
  #     programmatic access use Reason enum.
  class ProvisioningIssue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Reason for provisioning failures.
    module Reason
      # Reason is unspecified.
      REASON_UNSPECIFIED = 0

      # Certificate provisioning failed due to an issue with one or more of
      # the domains on the certificate.
      # For details of which domains failed, consult the
      # `authorization_attempt_info` field.
      AUTHORIZATION_ISSUE = 1

      # Exceeded Certificate Authority quotas or internal rate limits of the
      # system. Provisioning may take longer to complete.
      RATE_LIMITED = 2
    end
  end

  # State of the latest attempt to authorize a domain for certificate
  # issuance.
  # @!attribute [rw] domain
  #   @return [::String]
  #     Domain name of the authorization attempt.
  # @!attribute [r] state
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::State]
  #     Output only. State of the domain for managed certificate issuance.
  # @!attribute [r] failure_reason
  #   @return [::Google::Cloud::CertificateManager::V1::Certificate::ManagedCertificate::AuthorizationAttemptInfo::FailureReason]
  #     Output only. Reason for failure of the authorization attempt for the
  #     domain.
  # @!attribute [r] details
  #   @return [::String]
  #     Output only. Human readable explanation for reaching the state.
  #     Provided to help address the configuration issues. Not guaranteed to be
  #     stable. For programmatic access use FailureReason enum.
  class AuthorizationAttemptInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # State of the domain for managed certificate issuance.
    module State
      # State is unspecified.
      STATE_UNSPECIFIED = 0

      # Certificate provisioning for this domain is under way. Google Cloud
      # will attempt to authorize the domain.
      AUTHORIZING = 1

      # A managed certificate can be provisioned, no issues for this domain.
      AUTHORIZED = 6

      # Attempt to authorize the domain failed. This prevents the Managed
      # Certificate from being issued.
      # See `failure_reason` and `details` fields for more information.
      FAILED = 7
    end

    # Reason for failure of the authorization attempt for the domain.
    module FailureReason
      # FailureReason is unspecified.
      FAILURE_REASON_UNSPECIFIED = 0

      # There was a problem with the user's DNS or load balancer
      # configuration for this domain.
      CONFIG = 1

      # Certificate issuance forbidden by an explicit CAA record for the
      # domain or a failure to check CAA records for the domain.
      CAA = 2

      # Reached a CA or internal rate-limit for the domain,
      # e.g. for certificates per top-level private domain.
      RATE_LIMITED = 3
    end
  end

  # State of the managed certificate resource.
  module State
    # State is unspecified.
    STATE_UNSPECIFIED = 0

    # Certificate Manager attempts to provision or renew the certificate.
    # If the process takes longer than expected, consult the
    # `provisioning_issue` field.
    PROVISIONING = 1

    # Multiple certificate provisioning attempts failed and Certificate
    # Manager gave up. To try again, delete and create a new managed
    # Certificate resource.
    # For details see the `provisioning_issue` field.
    FAILED = 2

    # The certificate management is working, and a certificate has been
    # provisioned.
    ACTIVE = 3
  end
end