Class: Google::Cloud::CertificateManager::V1::DnsAuthorization

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

A DnsAuthorization resource describes a way to perform domain authorization for certificate issuance.

Defined Under Namespace

Modules: Type Classes: DnsResourceRecord, LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. The creation timestamp of a DnsAuthorization.

Returns:



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 823

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

  # The structure describing the DNS Resource Record that needs to be added
  # to DNS configuration for the authorization to be usable by
  # certificate.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. Fully qualified name of the DNS Resource Record.
  #     e.g. `_acme-challenge.example.com`
  # @!attribute [r] type
  #   @return [::String]
  #     Output only. Type of the DNS Resource Record.
  #     Currently always set to "CNAME".
  # @!attribute [r] data
  #   @return [::String]
  #     Output only. Data of the DNS Resource Record.
  class DnsResourceRecord
    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

  # DnsAuthorization type.
  module Type
    # Type is unspecified.
    TYPE_UNSPECIFIED = 0

    # FIXED_RECORD DNS authorization uses DNS-01 validation method.
    FIXED_RECORD = 1

    # PER_PROJECT_RECORD DNS authorization allows for independent management
    # of Google-managed certificates with DNS authorization across multiple
    # projects.
    PER_PROJECT_RECORD = 2
  end
end

#description ⇒ ::String

Returns One or more paragraphs of text description of a DnsAuthorization.

Returns:

  • (::String) —

    One or more paragraphs of text description of a DnsAuthorization.



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 823

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

  # The structure describing the DNS Resource Record that needs to be added
  # to DNS configuration for the authorization to be usable by
  # certificate.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. Fully qualified name of the DNS Resource Record.
  #     e.g. `_acme-challenge.example.com`
  # @!attribute [r] type
  #   @return [::String]
  #     Output only. Type of the DNS Resource Record.
  #     Currently always set to "CNAME".
  # @!attribute [r] data
  #   @return [::String]
  #     Output only. Data of the DNS Resource Record.
  class DnsResourceRecord
    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

  # DnsAuthorization type.
  module Type
    # Type is unspecified.
    TYPE_UNSPECIFIED = 0

    # FIXED_RECORD DNS authorization uses DNS-01 validation method.
    FIXED_RECORD = 1

    # PER_PROJECT_RECORD DNS authorization allows for independent management
    # of Google-managed certificates with DNS authorization across multiple
    # projects.
    PER_PROJECT_RECORD = 2
  end
end

#dns_resource_record ⇒ ::Google::Cloud::CertificateManager::V1::DnsAuthorization::DnsResourceRecord (readonly)

Returns Output only. DNS Resource Record that needs to be added to DNS configuration.

Returns:



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 823

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

  # The structure describing the DNS Resource Record that needs to be added
  # to DNS configuration for the authorization to be usable by
  # certificate.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. Fully qualified name of the DNS Resource Record.
  #     e.g. `_acme-challenge.example.com`
  # @!attribute [r] type
  #   @return [::String]
  #     Output only. Type of the DNS Resource Record.
  #     Currently always set to "CNAME".
  # @!attribute [r] data
  #   @return [::String]
  #     Output only. Data of the DNS Resource Record.
  class DnsResourceRecord
    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

  # DnsAuthorization type.
  module Type
    # Type is unspecified.
    TYPE_UNSPECIFIED = 0

    # FIXED_RECORD DNS authorization uses DNS-01 validation method.
    FIXED_RECORD = 1

    # PER_PROJECT_RECORD DNS authorization allows for independent management
    # of Google-managed certificates with DNS authorization across multiple
    # projects.
    PER_PROJECT_RECORD = 2
  end
end

#domain ⇒ ::String

Returns Required. Immutable. A domain that is being authorized. A DnsAuthorization resource covers a single domain and its wildcard, e.g. authorization for example.com can be used to issue certificates for example.com and *.example.com.

Returns:

  • (::String) —

    Required. Immutable. A domain that is being authorized. A DnsAuthorization resource covers a single domain and its wildcard, e.g. authorization for example.com can be used to issue certificates for example.com and *.example.com.



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 823

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

  # The structure describing the DNS Resource Record that needs to be added
  # to DNS configuration for the authorization to be usable by
  # certificate.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. Fully qualified name of the DNS Resource Record.
  #     e.g. `_acme-challenge.example.com`
  # @!attribute [r] type
  #   @return [::String]
  #     Output only. Type of the DNS Resource Record.
  #     Currently always set to "CNAME".
  # @!attribute [r] data
  #   @return [::String]
  #     Output only. Data of the DNS Resource Record.
  class DnsResourceRecord
    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

  # DnsAuthorization type.
  module Type
    # Type is unspecified.
    TYPE_UNSPECIFIED = 0

    # FIXED_RECORD DNS authorization uses DNS-01 validation method.
    FIXED_RECORD = 1

    # PER_PROJECT_RECORD DNS authorization allows for independent management
    # of Google-managed certificates with DNS authorization across multiple
    # projects.
    PER_PROJECT_RECORD = 2
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Set of labels associated with a DnsAuthorization.

Returns:

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

    Set of labels associated with a DnsAuthorization.



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 823

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

  # The structure describing the DNS Resource Record that needs to be added
  # to DNS configuration for the authorization to be usable by
  # certificate.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. Fully qualified name of the DNS Resource Record.
  #     e.g. `_acme-challenge.example.com`
  # @!attribute [r] type
  #   @return [::String]
  #     Output only. Type of the DNS Resource Record.
  #     Currently always set to "CNAME".
  # @!attribute [r] data
  #   @return [::String]
  #     Output only. Data of the DNS Resource Record.
  class DnsResourceRecord
    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

  # DnsAuthorization type.
  module Type
    # Type is unspecified.
    TYPE_UNSPECIFIED = 0

    # FIXED_RECORD DNS authorization uses DNS-01 validation method.
    FIXED_RECORD = 1

    # PER_PROJECT_RECORD DNS authorization allows for independent management
    # of Google-managed certificates with DNS authorization across multiple
    # projects.
    PER_PROJECT_RECORD = 2
  end
end

#name ⇒ ::String

Returns A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern projects/*/locations/*/dnsAuthorizations/*.

Returns:

  • (::String) —

    A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern projects/*/locations/*/dnsAuthorizations/*.



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 823

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

  # The structure describing the DNS Resource Record that needs to be added
  # to DNS configuration for the authorization to be usable by
  # certificate.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. Fully qualified name of the DNS Resource Record.
  #     e.g. `_acme-challenge.example.com`
  # @!attribute [r] type
  #   @return [::String]
  #     Output only. Type of the DNS Resource Record.
  #     Currently always set to "CNAME".
  # @!attribute [r] data
  #   @return [::String]
  #     Output only. Data of the DNS Resource Record.
  class DnsResourceRecord
    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

  # DnsAuthorization type.
  module Type
    # Type is unspecified.
    TYPE_UNSPECIFIED = 0

    # FIXED_RECORD DNS authorization uses DNS-01 validation method.
    FIXED_RECORD = 1

    # PER_PROJECT_RECORD DNS authorization allows for independent management
    # of Google-managed certificates with DNS authorization across multiple
    # projects.
    PER_PROJECT_RECORD = 2
  end
end

#type ⇒ ::Google::Cloud::CertificateManager::V1::DnsAuthorization::Type

Returns Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used:

  • in location global: FIXED_RECORD.

Returns:



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 823

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

  # The structure describing the DNS Resource Record that needs to be added
  # to DNS configuration for the authorization to be usable by
  # certificate.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. Fully qualified name of the DNS Resource Record.
  #     e.g. `_acme-challenge.example.com`
  # @!attribute [r] type
  #   @return [::String]
  #     Output only. Type of the DNS Resource Record.
  #     Currently always set to "CNAME".
  # @!attribute [r] data
  #   @return [::String]
  #     Output only. Data of the DNS Resource Record.
  class DnsResourceRecord
    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

  # DnsAuthorization type.
  module Type
    # Type is unspecified.
    TYPE_UNSPECIFIED = 0

    # FIXED_RECORD DNS authorization uses DNS-01 validation method.
    FIXED_RECORD = 1

    # PER_PROJECT_RECORD DNS authorization allows for independent management
    # of Google-managed certificates with DNS authorization across multiple
    # projects.
    PER_PROJECT_RECORD = 2
  end
end

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

Returns Output only. The last update timestamp of a DnsAuthorization.

Returns:



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'proto_docs/google/cloud/certificatemanager/v1/certificate_manager.rb', line 823

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

  # The structure describing the DNS Resource Record that needs to be added
  # to DNS configuration for the authorization to be usable by
  # certificate.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. Fully qualified name of the DNS Resource Record.
  #     e.g. `_acme-challenge.example.com`
  # @!attribute [r] type
  #   @return [::String]
  #     Output only. Type of the DNS Resource Record.
  #     Currently always set to "CNAME".
  # @!attribute [r] data
  #   @return [::String]
  #     Output only. Data of the DNS Resource Record.
  class DnsResourceRecord
    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

  # DnsAuthorization type.
  module Type
    # Type is unspecified.
    TYPE_UNSPECIFIED = 0

    # FIXED_RECORD DNS authorization uses DNS-01 validation method.
    FIXED_RECORD = 1

    # PER_PROJECT_RECORD DNS authorization allows for independent management
    # of Google-managed certificates with DNS authorization across multiple
    # projects.
    PER_PROJECT_RECORD = 2
  end
end