Discovery Engine API . projects . locations . cmekConfigs

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets the CmekConfig.

Args:
  name: string, Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configurations used to enable CMEK data encryption with Cloud KMS keys.
  "isDefault": True or False, # Output only. The default CmekConfig for the Customer.
  "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
  "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
  "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
  "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
  "state": "A String", # Output only. State of the CmekConfig.
}

list(parent, x__xgafv=None)

Lists all the CmekConfigs with the project.

Args:
  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for CmekConfigService.ListCmekConfigs method.
  "cmekConfigs": [ # All the customer's CmekConfigs.
    { # Configurations used to enable CMEK data encryption with Cloud KMS keys.
      "isDefault": True or False, # Output only. The default CmekConfig for the Customer.
      "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
      "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
      "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
      "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
      "state": "A String", # Output only. State of the CmekConfig.
    },
  ],
}

patch(name, body=None, setDefault=None, x__xgafv=None)

Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

Args:
  name: string, Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
  "isDefault": True or False, # Output only. The default CmekConfig for the Customer.
  "kmsKey": "A String", # Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
  "kmsKeyVersion": "A String", # Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
  "lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
  "name": "A String", # Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
  "state": "A String", # Output only. State of the CmekConfig.
}

  setDefault: boolean, Set the following CmekConfig as the default to be used for child resources if one is not specified.
  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, successful response of the operation. 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.
  },
}