# Certificate Manager API . projects . locations . certificateMaps

## Instance Methods

Returns the certificateMapEntries Resource.

Close httplib2 connections.

Creates a new CertificateMap in a given project and location.

Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

Gets details of a single CertificateMap.

Lists CertificateMaps in a given project and location.

Retrieves the next page of results.

Updates a CertificateMap.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, certificateMapId=None, x__xgafv=None)`

    Creates a new CertificateMap in a given project and location.

    Args:
      parent: string, Required. The parent resource of the certificate map. Must be in the format `projects/*/locations/*`. (required)
      body: object, The request body.
        The object takes the form of:

    { # Defines a collection of certificate configurations.
      "createTime": "A String", # Output only. The creation timestamp of a Certificate Map.
      "description": "A String", # One or more paragraphs of text description of a certificate map.
      "gclbTargets": [ # Output only. A list of GCLB targets which use this Certificate Map.
        { # Describes a Target Proxy which uses this Certificate Map.
          "ipConfigs": [ # IP configurations for this Target Proxy where the Certificate Map is serving.
            { # Defines IP configuration where this Certificate Map is serving.
              "ipAddress": "A String", # An external IP address.
              "ports": [ # Ports.
                42,
              ],
            },
          ],
          "targetHttpsProxy": "A String", # This field returns the resource name in the following format: `//compute.googleapis.com/projects/*/global/targetHttpsProxies/*`.
          "targetSslProxy": "A String", # This field returns the resource name in the following format: `//compute.googleapis.com/projects/*/global/targetSslProxies/*`.
        },
      ],
      "labels": { # Set of labels associated with a Certificate Map.
        "a_key": "A String",
      },
      "name": "A String", # A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.
      "updateTime": "A String", # Output only. The update timestamp of a Certificate Map.
    }

      certificateMapId: string, Required. A user-provided name of the certificate map.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`delete(name, x__xgafv=None)`

    Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

    Args:
      name: string, Required. A name of the certificate map to delete. Must be in the format `projects/*/locations/*/certificateMaps/*`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`get(name, x__xgafv=None)`

    Gets details of a single CertificateMap.

    Args:
      name: string, Required. A name of the certificate map to describe. Must be in the format `projects/*/locations/*/certificateMaps/*`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Defines a collection of certificate configurations.
      "createTime": "A String", # Output only. The creation timestamp of a Certificate Map.
      "description": "A String", # One or more paragraphs of text description of a certificate map.
      "gclbTargets": [ # Output only. A list of GCLB targets which use this Certificate Map.
        { # Describes a Target Proxy which uses this Certificate Map.
          "ipConfigs": [ # IP configurations for this Target Proxy where the Certificate Map is serving.
            { # Defines IP configuration where this Certificate Map is serving.
              "ipAddress": "A String", # An external IP address.
              "ports": [ # Ports.
                42,
              ],
            },
          ],
          "targetHttpsProxy": "A String", # This field returns the resource name in the following format: `//compute.googleapis.com/projects/*/global/targetHttpsProxies/*`.
          "targetSslProxy": "A String", # This field returns the resource name in the following format: `//compute.googleapis.com/projects/*/global/targetSslProxies/*`.
        },
      ],
      "labels": { # Set of labels associated with a Certificate Map.
        "a_key": "A String",
      },
      "name": "A String", # A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.
      "updateTime": "A String", # Output only. The update timestamp of a Certificate Map.
    }

`list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)`

    Lists CertificateMaps in a given project and location.

    Args:
      parent: string, Required. The project and location from which the certificate maps should be listed, specified in the format `projects/*/locations/*`. (required)
      filter: string, Filter expression to restrict the Certificates Maps returned.
      orderBy: string, A list of Certificate Map field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix " desc".
      pageSize: integer, Maximum number of certificate maps to return per call.
      pageToken: string, The value returned by the last `ListCertificateMapsResponse`. Indicates that this is a continuation of a prior `ListCertificateMaps` call, and that the system should return the next page of data.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response for the `ListCertificateMaps` method.
      "certificateMaps": [ # A list of certificate maps for the parent resource.
        { # Defines a collection of certificate configurations.
          "createTime": "A String", # Output only. The creation timestamp of a Certificate Map.
          "description": "A String", # One or more paragraphs of text description of a certificate map.
          "gclbTargets": [ # Output only. A list of GCLB targets which use this Certificate Map.
            { # Describes a Target Proxy which uses this Certificate Map.
              "ipConfigs": [ # IP configurations for this Target Proxy where the Certificate Map is serving.
                { # Defines IP configuration where this Certificate Map is serving.
                  "ipAddress": "A String", # An external IP address.
                  "ports": [ # Ports.
                    42,
                  ],
                },
              ],
              "targetHttpsProxy": "A String", # This field returns the resource name in the following format: `//compute.googleapis.com/projects/*/global/targetHttpsProxies/*`.
              "targetSslProxy": "A String", # This field returns the resource name in the following format: `//compute.googleapis.com/projects/*/global/targetSslProxies/*`.
            },
          ],
          "labels": { # Set of labels associated with a Certificate Map.
            "a_key": "A String",
          },
          "name": "A String", # A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.
          "updateTime": "A String", # Output only. The update timestamp of a Certificate Map.
        },
      ],
      "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
      "unreachable": [ # Locations that could not be reached.
        "A String",
      ],
    }

`list_next()`

    Retrieves the next page of results.

            Args:
              previous_request: The request for the previous page. (required)
              previous_response: The response from the request for the previous page. (required)

            Returns:
              A request object that you can call 'execute()' on to request the next
              page. Returns None if there are no more items in the collection.

`patch(name, body=None, updateMask=None, x__xgafv=None)`

    Updates a CertificateMap.

    Args:
      name: string, A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`. (required)
      body: object, The request body.
        The object takes the form of:

    { # Defines a collection of certificate configurations.
      "createTime": "A String", # Output only. The creation timestamp of a Certificate Map.
      "description": "A String", # One or more paragraphs of text description of a certificate map.
      "gclbTargets": [ # Output only. A list of GCLB targets which use this Certificate Map.
        { # Describes a Target Proxy which uses this Certificate Map.
          "ipConfigs": [ # IP configurations for this Target Proxy where the Certificate Map is serving.
            { # Defines IP configuration where this Certificate Map is serving.
              "ipAddress": "A String", # An external IP address.
              "ports": [ # Ports.
                42,
              ],
            },
          ],
          "targetHttpsProxy": "A String", # This field returns the resource name in the following format: `//compute.googleapis.com/projects/*/global/targetHttpsProxies/*`.
          "targetSslProxy": "A String", # This field returns the resource name in the following format: `//compute.googleapis.com/projects/*/global/targetSslProxies/*`.
        },
      ],
      "labels": { # Set of labels associated with a Certificate Map.
        "a_key": "A String",
      },
      "name": "A String", # A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.
      "updateTime": "A String", # Output only. The update timestamp of a Certificate Map.
    }

      updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }