2022-01-29
▼ ▲ cloudkms.projects.locations.ekmConnections.get
Description: Returns metadata for a given EkmConnection.
Path: v1/{+name}
Scopes:
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ekmConnections/{ekmConnectionsId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the EkmConnection to get.
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+$
▼ ▲ cloudkms.projects.locations.ekmConnections.list
HTTP Method: GET
Parameters:
pageSize
Description: Optional. Optional limit on the number of EkmConnections to include in the response. Further EkmConnections can subsequently be obtained by including the ListEkmConnectionsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
Type: integer
Location: query
Format: int32
pageToken
Type: string
Location: query
Description: Optional. Optional pagination token, returned earlier via ListEkmConnectionsResponse.next_page_token.
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Description: Required. The resource name of the location associated with the EkmConnections to list, in the format `projects/*/locations/*`.
filter
Type: string
Description: Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
Location: query
orderBy
Type: string
Description: Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
Location: query
Scopes:
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ekmConnections
Parameter Order: parent
Path: v1/{+parent}/ekmConnections
Description: Lists EkmConnections.
▼ ▲ cloudkms.projects.locations.ekmConnections.create
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ekmConnections
Path: v1/{+parent}/ekmConnections
Parameters:
parent
Required: Yes
Location: path
Type: string
Description: Required. The resource name of the location associated with the EkmConnection, in the format `projects/*/locations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+$
ekmConnectionId
Description: Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`.
Type: string
Location: query
Scopes:
HTTP Method: POST
Description: Creates a new EkmConnection in a given Project and Location.
Parameter Order: parent
▼ ▲ cloudkms.projects.locations.ekmConnections.patch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ekmConnections/{ekmConnectionsId}
Description: Updates an EkmConnection's metadata.
Parameter Order: name
Scopes:
Parameters:
updateMask
Location: query
Type: string
Description: Required. List of fields to be updated in this request.
Format: google-fieldmask
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+$
Description: Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
Location: path
Type: string
Path: v1/{+name}
HTTP Method: PATCH