2022-01-27
▼ ▲ cloudkms.projects.locations.ekmConnections.create
Parameters :
parent
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Description : Required. The resource name of the location associated with the EkmConnection, in the format `projects/*/locations/*`.
ekmConnectionId
Type : string
Location : query
Description : Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`.
Scopes :
Parameter Order : parent
Description : Creates a new EkmConnection in a given Project and Location.
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ekmConnections
Path : v1/{+parent}/ekmConnections
▼ ▲ cloudkms.projects.locations.ekmConnections.get
Scopes :
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Location : path
Description : Required. The name of the EkmConnection to get.
Pattern : ^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+$
Type : string
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ekmConnections/{ekmConnectionsId}
HTTP Method : GET
Description : Returns metadata for a given EkmConnection.
▼ ▲ cloudkms.projects.locations.ekmConnections.list
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ekmConnections
HTTP Method : GET
Parameters :
pageSize
Type : integer
Format : int32
Location : query
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.
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
parent
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Description : Required. The resource name of the location associated with the EkmConnections to list, in the format `projects/*/locations/*`.
pageToken
Description : Optional. Optional pagination token, returned earlier via ListEkmConnectionsResponse.next_page_token.
Location : query
Type : string
filter
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).
Type : string
Location : query
Parameter Order : parent
Path : v1/{+parent}/ekmConnections
Description : Lists EkmConnections.
▼ ▲ cloudkms.projects.locations.ekmConnections.patch
Parameters :
name
Description : Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+$
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : Required. List of fields to be updated in this request.
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ekmConnections/{ekmConnectionsId}
Description : Updates an EkmConnection's metadata.
Path : v1/{+name}
Parameter Order : name
HTTP Method : PATCH
▼ ▲ cloudkms.projects.locations.ekmConnections.create
Parameters :
parent
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Description : Required. The resource name of the location associated with the EkmConnection, in the format `projects/*/locations/*`.
ekmConnectionId
Type : string
Location : query
Description : Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`.
Scopes :
Parameter Order : parent
Description : Creates a new EkmConnection in a given Project and Location.
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ekmConnections
Path : v1/{+parent}/ekmConnections
▼ ▲ cloudkms.projects.locations.ekmConnections.get
Scopes :
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Location : path
Description : Required. The name of the EkmConnection to get.
Pattern : ^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+$
Type : string
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ekmConnections/{ekmConnectionsId}
HTTP Method : GET
Description : Returns metadata for a given EkmConnection.
▼ ▲ cloudkms.projects.locations.ekmConnections.list
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ekmConnections
HTTP Method : GET
Parameters :
pageSize
Type : integer
Format : int32
Location : query
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.
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
parent
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Description : Required. The resource name of the location associated with the EkmConnections to list, in the format `projects/*/locations/*`.
pageToken
Description : Optional. Optional pagination token, returned earlier via ListEkmConnectionsResponse.next_page_token.
Location : query
Type : string
filter
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).
Type : string
Location : query
Parameter Order : parent
Path : v1/{+parent}/ekmConnections
Description : Lists EkmConnections.
▼ ▲ cloudkms.projects.locations.ekmConnections.patch
Parameters :
name
Description : Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+$
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : Required. List of fields to be updated in this request.
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/ekmConnections/{ekmConnectionsId}
Description : Updates an EkmConnection's metadata.
Path : v1/{+name}
Parameter Order : name
HTTP Method : PATCH