Reference documentation and code samples for the Certificate Manager V1 API class Google::Cloud::CertificateManager::V1::CertificateMapEntry.
Defines a certificate map entry.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#certificates
defcertificates()->::Array<::String>
Returns
(::Array<::String>) — A set of Certificates defines for the given hostname. There can be
defined up to four certificates in each Certificate Map Entry. Each
certificate must match pattern projects/*/locations/*/certificates/*.
#certificates=
defcertificates=(value)->::Array<::String>
Parameter
value (::Array<::String>) — A set of Certificates defines for the given hostname. There can be
defined up to four certificates in each Certificate Map Entry. Each
certificate must match pattern projects/*/locations/*/certificates/*.
Returns
(::Array<::String>) — A set of Certificates defines for the given hostname. There can be
defined up to four certificates in each Certificate Map Entry. Each
certificate must match pattern projects/*/locations/*/certificates/*.
(::String) — One or more paragraphs of text description of a certificate map entry.
#description=
defdescription=(value)->::String
Parameter
value (::String) — One or more paragraphs of text description of a certificate map entry.
Returns
(::String) — One or more paragraphs of text description of a certificate map entry.
#hostname
defhostname()->::String
Returns
(::String) — A Hostname (FQDN, e.g. example.com) or a wildcard hostname expression
(*.example.com) for a set of hostnames with common suffix. Used as
Server Name Indication (SNI) for selecting a proper certificate.
Note: The following fields are mutually exclusive: hostname, matcher. If a field in that set is populated, all other fields in the set will automatically be cleared.
#hostname=
defhostname=(value)->::String
Parameter
value (::String) — A Hostname (FQDN, e.g. example.com) or a wildcard hostname expression
(*.example.com) for a set of hostnames with common suffix. Used as
Server Name Indication (SNI) for selecting a proper certificate.
Note: The following fields are mutually exclusive: hostname, matcher. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — A Hostname (FQDN, e.g. example.com) or a wildcard hostname expression
(*.example.com) for a set of hostnames with common suffix. Used as
Server Name Indication (SNI) for selecting a proper certificate.
Note: The following fields are mutually exclusive: hostname, matcher. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: matcher, hostname. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: matcher, hostname. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: matcher, hostname. If a field in that set is populated, all other fields in the set will automatically be cleared.
#name
defname()->::String
Returns
(::String) — A user-defined name of the Certificate Map Entry. Certificate Map Entry
names must be unique globally and match pattern
projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.
#name=
defname=(value)->::String
Parameter
value (::String) — A user-defined name of the Certificate Map Entry. Certificate Map Entry
names must be unique globally and match pattern
projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.
Returns
(::String) — A user-defined name of the Certificate Map Entry. Certificate Map Entry
names must be unique globally and match pattern
projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Certificate Manager V1 API - Class Google::Cloud::CertificateManager::V1::CertificateMapEntry (v1.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.0 (latest)](/ruby/docs/reference/google-cloud-certificate_manager-v1/latest/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [1.0.1](/ruby/docs/reference/google-cloud-certificate_manager-v1/1.0.1/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.12.0](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.12.0/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.11.0](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.11.0/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.10.1](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.10.1/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.9.0](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.9.0/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.8.2](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.8.2/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.7.0](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.7.0/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.6.0](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.6.0/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.5.0](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.5.0/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.4.2](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.4.2/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.3.1](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.3.1/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.2.0](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.2.0/Google-Cloud-CertificateManager-V1-CertificateMapEntry)\n- [0.1.0](/ruby/docs/reference/google-cloud-certificate_manager-v1/0.1.0/Google-Cloud-CertificateManager-V1-CertificateMapEntry) \nReference documentation and code samples for the Certificate Manager V1 API class Google::Cloud::CertificateManager::V1::CertificateMapEntry.\n\nDefines a certificate map entry. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #certificates\n\n def certificates() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/*/locations/*/certificates/*`.\n\n### #certificates=\n\n def certificates=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/*/locations/*/certificates/*`. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/*/locations/*/certificates/*`.\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The creation timestamp of a Certificate Map Entry.\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::String) --- One or more paragraphs of text description of a certificate map entry.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- One or more paragraphs of text description of a certificate map entry. \n**Returns**\n\n- (::String) --- One or more paragraphs of text description of a certificate map entry.\n\n### #hostname\n\n def hostname() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A Hostname (FQDN, e.g. `example.com`) or a wildcard hostname expression (`*.example.com`) for a set of hostnames with common suffix. Used as Server Name Indication (SNI) for selecting a proper certificate.\n\n\n Note: The following fields are mutually exclusive: `hostname`, `matcher`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #hostname=\n\n def hostname=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A Hostname (FQDN, e.g. `example.com`) or a wildcard hostname expression (`*.example.com`) for a set of hostnames with common suffix. Used as Server Name Indication (SNI) for selecting a proper certificate.\n\n\nNote: The following fields are mutually exclusive: `hostname`, `matcher`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- A Hostname (FQDN, e.g. `example.com`) or a wildcard hostname expression (`*.example.com`) for a set of hostnames with common suffix. Used as Server Name Indication (SNI) for selecting a proper certificate.\n\n\n Note: The following fields are mutually exclusive: `hostname`, `matcher`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #labels\n\n def labels() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Set of labels associated with a Certificate Map Entry.\n\n### #labels=\n\n def labels=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Set of labels associated with a Certificate Map Entry. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Set of labels associated with a Certificate Map Entry.\n\n### #matcher\n\n def matcher() -\u003e ::Google::Cloud::CertificateManager::V1::CertificateMapEntry::Matcher\n\n**Returns**\n\n- ([::Google::Cloud::CertificateManager::V1::CertificateMapEntry::Matcher](./Google-Cloud-CertificateManager-V1-CertificateMapEntry-Matcher)) --- A predefined matcher for particular cases, other than SNI selection.\n\n\n Note: The following fields are mutually exclusive: `matcher`, `hostname`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #matcher=\n\n def matcher=(value) -\u003e ::Google::Cloud::CertificateManager::V1::CertificateMapEntry::Matcher\n\n**Parameter**\n\n- **value** ([::Google::Cloud::CertificateManager::V1::CertificateMapEntry::Matcher](./Google-Cloud-CertificateManager-V1-CertificateMapEntry-Matcher)) --- A predefined matcher for particular cases, other than SNI selection.\n\n\nNote: The following fields are mutually exclusive: `matcher`, `hostname`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::CertificateManager::V1::CertificateMapEntry::Matcher](./Google-Cloud-CertificateManager-V1-CertificateMapEntry-Matcher)) --- A predefined matcher for particular cases, other than SNI selection.\n\n\n Note: The following fields are mutually exclusive: `matcher`, `hostname`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`. \n**Returns**\n\n- (::String) --- A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::CertificateManager::V1::ServingState\n\n**Returns**\n\n- ([::Google::Cloud::CertificateManager::V1::ServingState](./Google-Cloud-CertificateManager-V1-ServingState)) --- Output only. A serving state of this Certificate Map Entry.\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The update timestamp of a Certificate Map Entry."]]
