HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/394/lib/googlecloudsdk/api_lib/certificate_manager/certificate_maps.py
# -*- coding: utf-8 -*- #
# Copyright 2020 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""API client library for Certificate Manager certificate maps."""

from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals

from apitools.base.py import list_pager

from googlecloudsdk.api_lib.certificate_manager import api_client


class CertificateMapClient(object):
  """API client for Certificate Manager certificate maps."""

  def __init__(self, client=None, messages=None):
    self._client = client or api_client.GetClientInstance()
    self._service = self._client.projects_locations_certificateMaps
    self.messages = messages or self._client.MESSAGES_MODULE

  def Create(self, parent_ref, map_id, description='', labels=None, tags=None):
    """Creates a certificate map.

    Args:
      parent_ref: a Resource reference to a
        certificatemanager.projects.locations resource for the parent of this
        certificate map.
      map_id: str, the ID of the map to create.
      description: str, user-provided description.
      labels: Unified GCP Labels for the resource.
      tags: Unified GCP Tags for the resource.

    Returns:
      Operation: the long running operation to create a map.
    """
    req = self.messages.CertificatemanagerProjectsLocationsCertificateMapsCreateRequest(
        parent=parent_ref.RelativeName(),
        certificateMapId=map_id,
        certificateMap=self.messages.CertificateMap(
            labels=labels,
            description=description,
            tags=tags,
        ))

    return self._service.Create(req)

  def Get(self, map_ref):
    """Gets certificate map.

    Args:
      map_ref: a Resource reference to a
        certificatemanager.projects.locations.certificateMaps resource to get.

    Returns:
      Certificate Map API representation.
    """
    get_req = self.messages.CertificatemanagerProjectsLocationsCertificateMapsGetRequest(
        name=map_ref.RelativeName())
    return self._service.Get(get_req)

  def List(
      self,
      parent_ref,
      limit=None,
      page_size=None,
      list_filter=None,
      order_by=None,
  ):
    """List certificate maps in a given project and location.

    Args:
      parent_ref: a Resource reference to a
        certificatemanager.projects.locations resource to list maps for.
      limit: int, the total number of results to return from the API.
      page_size: int, the number of results in each batch from the API.
      list_filter: str, filter to apply in the list request.
      order_by: str, fields used for resource ordering.

    Returns:
      A list of the certificate maps in the project.
    """
    list_req = self.messages.CertificatemanagerProjectsLocationsCertificateMapsListRequest(
        parent=parent_ref.RelativeName(), filter=list_filter, orderBy=order_by)
    return list_pager.YieldFromList(
        self._service,
        list_req,
        batch_size=page_size,
        limit=limit,
        current_token_attribute='pageToken',
        next_token_attribute='nextPageToken',
        field='certificateMaps',
        batch_size_attribute='pageSize')

  def Delete(self, map_ref):
    """Deletes certificate map.

    Args:
      map_ref: a Resource reference to a
        certificatemanager.projects.locations.certificateMaps resource to
        delete.

    Returns:
      Operation: the long running operation to delete certificate map.
    """
    delete_req = self.messages.CertificatemanagerProjectsLocationsCertificateMapsDeleteRequest(
        name=map_ref.RelativeName())
    return self._service.Delete(delete_req)

  def Patch(self, map_ref, labels=None, description=None):
    """Updates a certificate map.

    Used for updating labels and description.

    Args:
      map_ref: a Resource reference to a
        certificatemanager.projects.locations.certificateMaps resource.
      labels: unified GCP Labels for the resource.
      description: str, new description

    Returns:
      Operation: the long running operation to patch certificate map.
    """
    certificate_map = self.messages.CertificateMap()
    updated_fields = []
    if labels:
      certificate_map.labels = labels
      updated_fields.append('labels')
    if description:
      certificate_map.description = description
      updated_fields.append('description')
    update_mask = ','.join(updated_fields)

    patch_req = self.messages.CertificatemanagerProjectsLocationsCertificateMapsPatchRequest(
        certificateMap=certificate_map,
        name=map_ref.RelativeName(),
        updateMask=update_mask)
    return self._service.Patch(patch_req)