Managed Service for Elasticsearch API, gRPC: ExtensionService
Call | Description |
---|---|
Get | Returns the specified extension of Elasticsearch cluster. |
List | Returns the list of available extensions for the specified Elasticsearch cluster. |
Create | Creates new extension version. |
Update | Updates the specified extension. |
Delete | Deletes the specified extension. |
Calls ExtensionService
Get
Returns the specified extension of Elasticsearch cluster.
rpc Get (GetExtensionRequest) returns (Extension)
GetExtensionRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster. The maximum string length in characters is 50. |
extension_id | string Required. ID of the extension to return. |
Extension
Field | Description |
---|---|
name | string Name of the extension. |
id | string Unique ID of the extension. |
cluster_id | string ID of the Elasticsearch cluster the extension belongs to. |
version | int64 Version of the extension. |
active | bool The flag shows whether the extension is active. |
List
Returns the list of available extensions for the specified Elasticsearch cluster.
rpc List (ListExtensionsRequest) returns (ListExtensionsResponse)
ListExtensionsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster to list extensions in. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the API returns a ListExtensionsResponse.next_page_token that can be used to get the next page of results in subsequent ExtensionService.List requests. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token that can be used to iterate through multiple pages of results. To get the next page of results, set page_token to the ListExtensionsResponse.next_page_token returned by the previous ExtensionService.List request. The maximum string length in characters is 100. |
ListExtensionsResponse
Field | Description |
---|---|
extensions[] | Extension Requested list of extensions. |
next_page_token | string The token that can be used to get the next page of results. If the number of results is larger than ListExtensionsRequest.page_size, use the next_page_token as the value for the ListExtensionsRequest.page_token in the subsequent ExtensionService.List request to iterate through multiple pages of results. Each of the subsequent ExtensionService.List requests should use the next_page_token value returned in the previous request to continue paging through the results. |
Extension
Field | Description |
---|---|
name | string Name of the extension. |
id | string Unique ID of the extension. |
cluster_id | string ID of the Elasticsearch cluster the extension belongs to. |
version | int64 Version of the extension. |
active | bool The flag shows whether the extension is active. |
Create
Creates new extension version.
rpc Create (CreateExtensionRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateExtensionMetadata
Operation.response:Extension
CreateExtensionRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster. The maximum string length in characters is 50. |
name | string Required. Name of the extension. The maximum string length in characters is 50. |
uri | string Required. URI of the zip archive to create the new extension from. Currently only supports links that are stored in Object Storage. |
disabled | bool The flag that disables the extension. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool 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. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateExtensionMetadata
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster. The maximum string length in characters is 50. |
extension_id | string Required. ID of the extension. |
Extension
Field | Description |
---|---|
name | string Name of the extension. |
id | string Unique ID of the extension. |
cluster_id | string ID of the Elasticsearch cluster the extension belongs to. |
version | int64 Version of the extension. |
active | bool The flag shows whether the extension is active. |
Update
Updates the specified extension.
rpc Update (UpdateExtensionRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateExtensionMetadata
Operation.response:Extension
UpdateExtensionRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster. The maximum string length in characters is 50. |
extension_id | string Required. ID of the extension to update. |
active | bool The flag shows whether to make the extension active. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool 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. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateExtensionMetadata
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster. The maximum string length in characters is 50. |
extension_id | string Required. ID of the extension. |
Extension
Field | Description |
---|---|
name | string Name of the extension. |
id | string Unique ID of the extension. |
cluster_id | string ID of the Elasticsearch cluster the extension belongs to. |
version | int64 Version of the extension. |
active | bool The flag shows whether the extension is active. |
Delete
Deletes the specified extension.
rpc Delete (DeleteExtensionRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteExtensionMetadata
Operation.response:google.protobuf.Empty
DeleteExtensionRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster. The maximum string length in characters is 50. |
extension_id | string Required. ID of the extension to delete. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool 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. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteExtensionMetadata
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster. The maximum string length in characters is 50. |
extension_id | string Required. ID of the extension to delete. |