Managed Service for Apache Kafka® API, gRPC: ResourcePresetService
Written by
A set of methods for managing Kafka resource presets.
| Call | Description |
|---|---|
| Get | Returns the specified resource preset. |
| List | Retrieves the list of available resource presets. |
Calls ResourcePresetService
Get
Returns the specified resource preset.
To get the list of available resource presets, make a List request.
rpc Get (GetResourcePresetRequest) returns (ResourcePreset)
GetResourcePresetRequest
| Field | Description |
|---|---|
| resource_preset_id | string Required. ID of the resource preset to return. To get the resource preset ID, use a ResourcePresetService.List request. |
ResourcePreset
| Field | Description |
|---|---|
| id | string ID of the resource preset. |
| zone_ids[] | string IDs of availability zones where the resource preset is available. |
| cores | int64 Number of CPU cores for a Kafka broker created with the preset. |
| memory | int64 RAM volume for a Kafka broker created with the preset, in bytes. |
List
Retrieves the list of available resource presets.
rpc List (ListResourcePresetsRequest) returns (ListResourcePresetsResponse)
ListResourcePresetsRequest
| Field | Description |
|---|---|
| page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListResourcePresetsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
| page_token | string Page token. To get the next page of results, set page_token to the ListResourcePresetsResponse.next_page_token, returned by the previous list request. The maximum string length in characters is 100. |
ListResourcePresetsResponse
| Field | Description |
|---|---|
| resource_presets[] | ResourcePreset List of resource presets. |
| next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListResourcePresetsRequest.page_size, use next_page_token as the value for the ListResourcePresetsRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. The maximum string length in characters is 100. |
ResourcePreset
| Field | Description |
|---|---|
| id | string ID of the resource preset. |
| zone_ids[] | string IDs of availability zones where the resource preset is available. |
| cores | int64 Number of CPU cores for a Kafka broker created with the preset. |
| memory | int64 RAM volume for a Kafka broker created with the preset, in bytes. |