App Engine Admin V1 API - Class Google::Cloud::AppEngine::V1::AuthorizedCertificate (v0.9.0)

Reference documentation and code samples for the App Engine Admin V1 API class Google::Cloud::AppEngine::V1::AuthorizedCertificate.

An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#certificate_raw_data

def certificate_raw_data() -> ::Google::Cloud::AppEngine::V1::CertificateRawData
Returns

#certificate_raw_data=

def certificate_raw_data=(value) -> ::Google::Cloud::AppEngine::V1::CertificateRawData
Parameter
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
Returns
  • (::String) — The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.

#domain_mappings_count

def domain_mappings_count() -> ::Integer
Returns
  • (::Integer) — Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.

    Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.

#domain_mappings_count=

def domain_mappings_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.

    Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.

Returns
  • (::Integer) — Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.

    Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.

#domain_names

def domain_names() -> ::Array<::String>
Returns
  • (::Array<::String>) — Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.

#domain_names=

def domain_names=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.
Returns
  • (::Array<::String>) — Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.

#expire_time

def expire_time() -> ::Google::Protobuf::Timestamp
Returns

#expire_time=

def expire_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#id

def id() -> ::String
Returns
  • (::String) — Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.
Returns
  • (::String) — Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.

#managed_certificate

def managed_certificate() -> ::Google::Cloud::AppEngine::V1::ManagedCertificate
Returns
  • (::Google::Cloud::AppEngine::V1::ManagedCertificate) — Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.

#managed_certificate=

def managed_certificate=(value) -> ::Google::Cloud::AppEngine::V1::ManagedCertificate
Parameter
  • value (::Google::Cloud::AppEngine::V1::ManagedCertificate) — Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.
Returns
  • (::Google::Cloud::AppEngine::V1::ManagedCertificate) — Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.

#name

def name() -> ::String
Returns
  • (::String) — Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.
Returns
  • (::String) — Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.

#visible_domain_mappings

def visible_domain_mappings() -> ::Array<::String>
Returns
  • (::Array<::String>) — The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.

    This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.

    Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.

#visible_domain_mappings=

def visible_domain_mappings=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.

    This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.

    Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.

Returns
  • (::Array<::String>) — The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.

    This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.

    Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.