cloud_memcache.proto 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658
  1. // Copyright 2022 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. syntax = "proto3";
  15. package google.cloud.memcache.v1beta2;
  16. import "google/api/annotations.proto";
  17. import "google/api/client.proto";
  18. import "google/api/field_behavior.proto";
  19. import "google/api/resource.proto";
  20. import "google/longrunning/operations.proto";
  21. import "google/protobuf/duration.proto";
  22. import "google/protobuf/field_mask.proto";
  23. import "google/protobuf/timestamp.proto";
  24. import "google/type/dayofweek.proto";
  25. import "google/type/timeofday.proto";
  26. option go_package = "google.golang.org/genproto/googleapis/cloud/memcache/v1beta2;memcache";
  27. option java_multiple_files = true;
  28. option java_outer_classname = "CloudMemcacheProto";
  29. option java_package = "com.google.cloud.memcache.v1beta2";
  30. // Configures and manages Cloud Memorystore for Memcached instances.
  31. //
  32. //
  33. // The `memcache.googleapis.com` service implements the Google Cloud Memorystore
  34. // for Memcached API and defines the following resource model for managing
  35. // Memorystore Memcached (also called Memcached below) instances:
  36. // * The service works with a collection of cloud projects, named: `/projects/*`
  37. // * Each project has a collection of available locations, named: `/locations/*`
  38. // * Each location has a collection of Memcached instances, named:
  39. // `/instances/*`
  40. // * As such, Memcached instances are resources of the form:
  41. // `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
  42. //
  43. // Note that location_id must be a GCP `region`; for example:
  44. // * `projects/my-memcached-project/locations/us-central1/instances/my-memcached`
  45. service CloudMemcache {
  46. option (google.api.default_host) = "memcache.googleapis.com";
  47. option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
  48. // Lists Instances in a given location.
  49. rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse) {
  50. option (google.api.http) = {
  51. get: "/v1beta2/{parent=projects/*/locations/*}/instances"
  52. };
  53. option (google.api.method_signature) = "parent";
  54. }
  55. // Gets details of a single Instance.
  56. rpc GetInstance(GetInstanceRequest) returns (Instance) {
  57. option (google.api.http) = {
  58. get: "/v1beta2/{name=projects/*/locations/*/instances/*}"
  59. };
  60. option (google.api.method_signature) = "name";
  61. }
  62. // Creates a new Instance in a given location.
  63. rpc CreateInstance(CreateInstanceRequest) returns (google.longrunning.Operation) {
  64. option (google.api.http) = {
  65. post: "/v1beta2/{parent=projects/*/locations/*}/instances"
  66. body: "resource"
  67. };
  68. option (google.api.method_signature) = "parent,instance_id,resource";
  69. option (google.longrunning.operation_info) = {
  70. response_type: "google.cloud.memcache.v1beta2.Instance"
  71. metadata_type: "google.cloud.memcache.v1beta2.OperationMetadata"
  72. };
  73. }
  74. // Updates an existing Instance in a given project and location.
  75. rpc UpdateInstance(UpdateInstanceRequest) returns (google.longrunning.Operation) {
  76. option (google.api.http) = {
  77. patch: "/v1beta2/{resource.name=projects/*/locations/*/instances/*}"
  78. body: "resource"
  79. };
  80. option (google.api.method_signature) = "update_mask,resource";
  81. option (google.longrunning.operation_info) = {
  82. response_type: "google.cloud.memcache.v1beta2.Instance"
  83. metadata_type: "google.cloud.memcache.v1beta2.OperationMetadata"
  84. };
  85. }
  86. // Updates the defined Memcached parameters for an existing instance.
  87. // This method only stages the parameters, it must be followed by
  88. // `ApplyParameters` to apply the parameters to nodes of the Memcached
  89. // instance.
  90. rpc UpdateParameters(UpdateParametersRequest) returns (google.longrunning.Operation) {
  91. option (google.api.http) = {
  92. patch: "/v1beta2/{name=projects/*/locations/*/instances/*}:updateParameters"
  93. body: "*"
  94. };
  95. option (google.api.method_signature) = "name,update_mask,parameters";
  96. option (google.longrunning.operation_info) = {
  97. response_type: "google.cloud.memcache.v1beta2.Instance"
  98. metadata_type: "google.cloud.memcache.v1beta2.OperationMetadata"
  99. };
  100. }
  101. // Deletes a single Instance.
  102. rpc DeleteInstance(DeleteInstanceRequest) returns (google.longrunning.Operation) {
  103. option (google.api.http) = {
  104. delete: "/v1beta2/{name=projects/*/locations/*/instances/*}"
  105. };
  106. option (google.api.method_signature) = "name";
  107. option (google.longrunning.operation_info) = {
  108. response_type: "google.protobuf.Empty"
  109. metadata_type: "google.cloud.memcache.v1beta2.OperationMetadata"
  110. };
  111. }
  112. // `ApplyParameters` restarts the set of specified nodes in order to update
  113. // them to the current set of parameters for the Memcached Instance.
  114. rpc ApplyParameters(ApplyParametersRequest) returns (google.longrunning.Operation) {
  115. option (google.api.http) = {
  116. post: "/v1beta2/{name=projects/*/locations/*/instances/*}:applyParameters"
  117. body: "*"
  118. };
  119. option (google.api.method_signature) = "name,node_ids,apply_all";
  120. option (google.longrunning.operation_info) = {
  121. response_type: "google.cloud.memcache.v1beta2.Instance"
  122. metadata_type: "google.cloud.memcache.v1beta2.OperationMetadata"
  123. };
  124. }
  125. // Updates software on the selected nodes of the Instance.
  126. rpc ApplySoftwareUpdate(ApplySoftwareUpdateRequest) returns (google.longrunning.Operation) {
  127. option (google.api.http) = {
  128. post: "/v1beta2/{instance=projects/*/locations/*/instances/*}:applySoftwareUpdate"
  129. body: "*"
  130. };
  131. option (google.api.method_signature) = "instance,node_ids,apply_all";
  132. option (google.longrunning.operation_info) = {
  133. response_type: "google.cloud.memcache.v1beta2.Instance"
  134. metadata_type: "google.cloud.memcache.v1beta2.OperationMetadata"
  135. };
  136. }
  137. // Performs the apply phase of the RescheduleMaintenance verb.
  138. rpc RescheduleMaintenance(RescheduleMaintenanceRequest) returns (google.longrunning.Operation) {
  139. option (google.api.http) = {
  140. post: "/v1beta2/{instance=projects/*/locations/*/instances/*}:rescheduleMaintenance"
  141. body: "*"
  142. };
  143. option (google.api.method_signature) = "instance, reschedule_type, schedule_time";
  144. option (google.longrunning.operation_info) = {
  145. response_type: "google.cloud.memcache.v1beta2.Instance"
  146. metadata_type: "google.cloud.memcache.v1beta2.OperationMetadata"
  147. };
  148. }
  149. }
  150. // A Memorystore for Memcached instance
  151. message Instance {
  152. option (google.api.resource) = {
  153. type: "memcache.googleapis.com/Instance"
  154. pattern: "projects/{project}/locations/{location}/instances/{instance}"
  155. };
  156. // Different states of a Memcached instance.
  157. enum State {
  158. // State not set.
  159. STATE_UNSPECIFIED = 0;
  160. // Memcached instance is being created.
  161. CREATING = 1;
  162. // Memcached instance has been created and ready to be used.
  163. READY = 2;
  164. // Memcached instance is updating configuration such as maintenance policy
  165. // and schedule.
  166. UPDATING = 3;
  167. // Memcached instance is being deleted.
  168. DELETING = 4;
  169. // Memcached instance is going through maintenance, e.g. data plane rollout.
  170. PERFORMING_MAINTENANCE = 5;
  171. }
  172. // Configuration for a Memcached Node.
  173. message NodeConfig {
  174. // Required. Number of cpus per Memcached node.
  175. int32 cpu_count = 1 [(google.api.field_behavior) = REQUIRED];
  176. // Required. Memory size in MiB for each Memcached node.
  177. int32 memory_size_mb = 2 [(google.api.field_behavior) = REQUIRED];
  178. }
  179. message Node {
  180. // Different states of a Memcached node.
  181. enum State {
  182. // Node state is not set.
  183. STATE_UNSPECIFIED = 0;
  184. // Node is being created.
  185. CREATING = 1;
  186. // Node has been created and ready to be used.
  187. READY = 2;
  188. // Node is being deleted.
  189. DELETING = 3;
  190. // Node is being updated.
  191. UPDATING = 4;
  192. }
  193. // Output only. Identifier of the Memcached node. The node id does not
  194. // include project or location like the Memcached instance name.
  195. string node_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  196. // Output only. Location (GCP Zone) for the Memcached node.
  197. string zone = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  198. // Output only. Current state of the Memcached node.
  199. State state = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
  200. // Output only. Hostname or IP address of the Memcached node used by the
  201. // clients to connect to the Memcached server on this node.
  202. string host = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
  203. // Output only. The port number of the Memcached server on this node.
  204. int32 port = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
  205. // User defined parameters currently applied to the node.
  206. MemcacheParameters parameters = 6;
  207. // Output only. Returns true if there is an update waiting to be applied
  208. bool update_available = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
  209. }
  210. message InstanceMessage {
  211. enum Code {
  212. // Message Code not set.
  213. CODE_UNSPECIFIED = 0;
  214. // Memcached nodes are distributed unevenly.
  215. ZONE_DISTRIBUTION_UNBALANCED = 1;
  216. }
  217. // A code that correspond to one type of user-facing message.
  218. Code code = 1;
  219. // Message on memcached instance which will be exposed to users.
  220. string message = 2;
  221. }
  222. // Required. Unique name of the resource in this scope including project and
  223. // location using the form:
  224. // `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
  225. //
  226. // Note: Memcached instances are managed and addressed at the regional level
  227. // so `location_id` here refers to a Google Cloud region; however, users may
  228. // choose which zones Memcached nodes should be provisioned in within an
  229. // instance. Refer to [zones][google.cloud.memcache.v1beta2.Instance.zones] field for more details.
  230. string name = 1 [(google.api.field_behavior) = REQUIRED];
  231. // User provided name for the instance, which is only used for display
  232. // purposes. Cannot be more than 80 characters.
  233. string display_name = 2;
  234. // Resource labels to represent user-provided metadata.
  235. // Refer to cloud documentation on labels for more details.
  236. // https://cloud.google.com/compute/docs/labeling-resources
  237. map<string, string> labels = 3;
  238. // The full name of the Google Compute Engine
  239. // [network](https://cloud.google.com/vpc/docs/vpc) to which the
  240. // instance is connected. If left unspecified, the `default` network
  241. // will be used.
  242. string authorized_network = 4;
  243. // Zones in which Memcached nodes should be provisioned.
  244. // Memcached nodes will be equally distributed across these zones. If not
  245. // provided, the service will by default create nodes in all zones in the
  246. // region for the instance.
  247. repeated string zones = 5;
  248. // Required. Number of nodes in the Memcached instance.
  249. int32 node_count = 6 [(google.api.field_behavior) = REQUIRED];
  250. // Required. Configuration for Memcached nodes.
  251. NodeConfig node_config = 7 [(google.api.field_behavior) = REQUIRED];
  252. // The major version of Memcached software.
  253. // If not provided, latest supported version will be used. Currently the
  254. // latest supported major version is `MEMCACHE_1_5`.
  255. // The minor version will be automatically determined by our system based on
  256. // the latest supported minor version.
  257. MemcacheVersion memcache_version = 9;
  258. // User defined parameters to apply to the memcached process
  259. // on each node.
  260. MemcacheParameters parameters = 11;
  261. // Output only. List of Memcached nodes.
  262. // Refer to [Node][google.cloud.memcache.v1beta2.Instance.Node] message for more details.
  263. repeated Node memcache_nodes = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
  264. // Output only. The time the instance was created.
  265. google.protobuf.Timestamp create_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
  266. // Output only. The time the instance was updated.
  267. google.protobuf.Timestamp update_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
  268. // Output only. The state of this Memcached instance.
  269. State state = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
  270. // Output only. The full version of memcached server running on this instance.
  271. // System automatically determines the full memcached version for an instance
  272. // based on the input MemcacheVersion.
  273. // The full version format will be "memcached-1.5.16".
  274. string memcache_full_version = 18 [(google.api.field_behavior) = OUTPUT_ONLY];
  275. // List of messages that describe the current state of the Memcached instance.
  276. repeated InstanceMessage instance_messages = 19;
  277. // Output only. Endpoint for the Discovery API.
  278. string discovery_endpoint = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
  279. // Output only. Returns true if there is an update waiting to be applied
  280. bool update_available = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
  281. // The maintenance policy for the instance. If not provided,
  282. // the maintenance event will be performed based on Memorystore
  283. // internal rollout schedule.
  284. MaintenancePolicy maintenance_policy = 22;
  285. // Output only. Published maintenance schedule.
  286. MaintenanceSchedule maintenance_schedule = 23 [(google.api.field_behavior) = OUTPUT_ONLY];
  287. }
  288. // Maintenance policy per instance.
  289. message MaintenancePolicy {
  290. // Output only. The time when the policy was created.
  291. google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  292. // Output only. The time when the policy was updated.
  293. google.protobuf.Timestamp update_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  294. // Description of what this policy is for. Create/Update methods
  295. // return INVALID_ARGUMENT if the length is greater than 512.
  296. string description = 3;
  297. // Required. Maintenance window that is applied to resources covered by this
  298. // policy. Minimum 1. For the current version, the maximum number of
  299. // weekly_maintenance_windows is expected to be one.
  300. repeated WeeklyMaintenanceWindow weekly_maintenance_window = 4 [(google.api.field_behavior) = REQUIRED];
  301. }
  302. // Time window specified for weekly operations.
  303. message WeeklyMaintenanceWindow {
  304. // Required. Allows to define schedule that runs specified day of the week.
  305. google.type.DayOfWeek day = 1 [(google.api.field_behavior) = REQUIRED];
  306. // Required. Start time of the window in UTC.
  307. google.type.TimeOfDay start_time = 2 [(google.api.field_behavior) = REQUIRED];
  308. // Required. Duration of the time window.
  309. google.protobuf.Duration duration = 3 [(google.api.field_behavior) = REQUIRED];
  310. }
  311. // Upcoming maintenance schedule.
  312. message MaintenanceSchedule {
  313. // Output only. The start time of any upcoming scheduled maintenance for this instance.
  314. google.protobuf.Timestamp start_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  315. // Output only. The end time of any upcoming scheduled maintenance for this instance.
  316. google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  317. // Output only. The deadline that the maintenance schedule start time can not go beyond,
  318. // including reschedule.
  319. google.protobuf.Timestamp schedule_deadline_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
  320. }
  321. // Request for [ListInstances][google.cloud.memcache.v1beta2.CloudMemcache.ListInstances].
  322. message ListInstancesRequest {
  323. // Required. The resource name of the instance location using the form:
  324. // `projects/{project_id}/locations/{location_id}`
  325. // where `location_id` refers to a GCP region
  326. string parent = 1 [
  327. (google.api.field_behavior) = REQUIRED,
  328. (google.api.resource_reference) = {
  329. type: "locations.googleapis.com/Location"
  330. }
  331. ];
  332. // The maximum number of items to return.
  333. //
  334. // If not specified, a default value of 1000 will be used by the service.
  335. // Regardless of the `page_size` value, the response may include a partial
  336. // list and a caller should only rely on response's
  337. // [`next_page_token`][google.cloud.memcache.v1beta2.ListInstancesResponse.next_page_token]
  338. // to determine if there are more instances left to be queried.
  339. int32 page_size = 2;
  340. // The `next_page_token` value returned from a previous List request, if any.
  341. string page_token = 3;
  342. // List filter. For example, exclude all Memcached instances with name as
  343. // my-instance by specifying `"name != my-instance"`.
  344. string filter = 4;
  345. // Sort results. Supported values are "name", "name desc" or "" (unsorted).
  346. string order_by = 5;
  347. }
  348. // Response for [ListInstances][google.cloud.memcache.v1beta2.CloudMemcache.ListInstances].
  349. message ListInstancesResponse {
  350. // A list of Memcached instances in the project in the specified location,
  351. // or across all locations.
  352. //
  353. // If the `location_id` in the parent field of the request is "-", all regions
  354. // available to the project are queried, and the results aggregated.
  355. repeated Instance resources = 1;
  356. // Token to retrieve the next page of results, or empty if there are no more
  357. // results in the list.
  358. string next_page_token = 2;
  359. // Locations that could not be reached.
  360. repeated string unreachable = 3;
  361. }
  362. // Request for [GetInstance][google.cloud.memcache.v1beta2.CloudMemcache.GetInstance].
  363. message GetInstanceRequest {
  364. // Required. Memcached instance resource name in the format:
  365. // `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
  366. // where `location_id` refers to a GCP region
  367. string name = 1 [
  368. (google.api.field_behavior) = REQUIRED,
  369. (google.api.resource_reference) = {
  370. type: "memcache.googleapis.com/Instance"
  371. }
  372. ];
  373. }
  374. // Request for [CreateInstance][google.cloud.memcache.v1beta2.CloudMemcache.CreateInstance].
  375. message CreateInstanceRequest {
  376. // Required. The resource name of the instance location using the form:
  377. // `projects/{project_id}/locations/{location_id}`
  378. // where `location_id` refers to a GCP region
  379. string parent = 1 [
  380. (google.api.field_behavior) = REQUIRED,
  381. (google.api.resource_reference) = {
  382. type: "locations.googleapis.com/Location"
  383. }
  384. ];
  385. // Required. The logical name of the Memcached instance in the user
  386. // project with the following restrictions:
  387. //
  388. // * Must contain only lowercase letters, numbers, and hyphens.
  389. // * Must start with a letter.
  390. // * Must be between 1-40 characters.
  391. // * Must end with a number or a letter.
  392. // * Must be unique within the user project / location.
  393. //
  394. // If any of the above are not met, the API raises an invalid argument error.
  395. string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
  396. // Required. A Memcached [Instance] resource
  397. Instance resource = 3 [(google.api.field_behavior) = REQUIRED];
  398. }
  399. // Request for [UpdateInstance][google.cloud.memcache.v1beta2.CloudMemcache.UpdateInstance].
  400. message UpdateInstanceRequest {
  401. // Required. Mask of fields to update.
  402. //
  403. // * `displayName`
  404. google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED];
  405. // Required. A Memcached [Instance] resource.
  406. // Only fields specified in update_mask are updated.
  407. Instance resource = 2 [(google.api.field_behavior) = REQUIRED];
  408. }
  409. // Request for [DeleteInstance][google.cloud.memcache.v1beta2.CloudMemcache.DeleteInstance].
  410. message DeleteInstanceRequest {
  411. // Required. Memcached instance resource name in the format:
  412. // `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
  413. // where `location_id` refers to a GCP region
  414. string name = 1 [
  415. (google.api.field_behavior) = REQUIRED,
  416. (google.api.resource_reference) = {
  417. type: "memcache.googleapis.com/Instance"
  418. }
  419. ];
  420. }
  421. // Request for [RescheduleMaintenance][google.cloud.memcache.v1beta2.CloudMemcache.RescheduleMaintenance].
  422. message RescheduleMaintenanceRequest {
  423. // Reschedule options.
  424. enum RescheduleType {
  425. // Not set.
  426. RESCHEDULE_TYPE_UNSPECIFIED = 0;
  427. // If the user wants to schedule the maintenance to happen now.
  428. IMMEDIATE = 1;
  429. // If the user wants to use the existing maintenance policy to find the
  430. // next available window.
  431. NEXT_AVAILABLE_WINDOW = 2;
  432. // If the user wants to reschedule the maintenance to a specific time.
  433. SPECIFIC_TIME = 3;
  434. }
  435. // Required. Memcache instance resource name using the form:
  436. // `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
  437. // where `location_id` refers to a GCP region.
  438. string instance = 1 [
  439. (google.api.field_behavior) = REQUIRED,
  440. (google.api.resource_reference) = {
  441. type: "memcache.googleapis.com/Instance"
  442. }
  443. ];
  444. // Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
  445. RescheduleType reschedule_type = 2 [(google.api.field_behavior) = REQUIRED];
  446. // Timestamp when the maintenance shall be rescheduled to if
  447. // reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for
  448. // example `2012-11-15T16:19:00.094Z`.
  449. google.protobuf.Timestamp schedule_time = 3;
  450. }
  451. // Request for [ApplyParameters][google.cloud.memcache.v1beta2.CloudMemcache.ApplyParameters].
  452. message ApplyParametersRequest {
  453. // Required. Resource name of the Memcached instance for which parameter group updates
  454. // should be applied.
  455. string name = 1 [
  456. (google.api.field_behavior) = REQUIRED,
  457. (google.api.resource_reference) = {
  458. type: "memcache.googleapis.com/Instance"
  459. }
  460. ];
  461. // Nodes to which the instance-level parameter group is applied.
  462. repeated string node_ids = 2;
  463. // Whether to apply instance-level parameter group to all nodes. If set to
  464. // true, users are restricted from specifying individual nodes, and
  465. // `ApplyParameters` updates all nodes within the instance.
  466. bool apply_all = 3;
  467. }
  468. // Request for [UpdateParameters][google.cloud.memcache.v1beta2.CloudMemcache.UpdateParameters].
  469. message UpdateParametersRequest {
  470. // Required. Resource name of the Memcached instance for which the parameters should be
  471. // updated.
  472. string name = 1 [
  473. (google.api.field_behavior) = REQUIRED,
  474. (google.api.resource_reference) = {
  475. type: "memcache.googleapis.com/Instance"
  476. }
  477. ];
  478. // Required. Mask of fields to update.
  479. google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
  480. // The parameters to apply to the instance.
  481. MemcacheParameters parameters = 3;
  482. }
  483. // Request for [ApplySoftwareUpdate][google.cloud.memcache.v1beta2.CloudMemcache.ApplySoftwareUpdate].
  484. message ApplySoftwareUpdateRequest {
  485. // Required. Resource name of the Memcached instance for which software update should be
  486. // applied.
  487. string instance = 1 [
  488. (google.api.field_behavior) = REQUIRED,
  489. (google.api.resource_reference) = {
  490. type: "memcache.googleapis.com/Instance"
  491. }
  492. ];
  493. // Nodes to which we should apply the update to. Note all the selected nodes
  494. // are updated in parallel.
  495. repeated string node_ids = 2;
  496. // Whether to apply the update to all nodes. If set to
  497. // true, will explicitly restrict users from specifying any nodes, and apply
  498. // software update to all nodes (where applicable) within the instance.
  499. bool apply_all = 3;
  500. }
  501. // Memcached versions supported by our service.
  502. enum MemcacheVersion {
  503. MEMCACHE_VERSION_UNSPECIFIED = 0;
  504. // Memcached 1.5 version.
  505. MEMCACHE_1_5 = 1;
  506. }
  507. message MemcacheParameters {
  508. // Output only. The unique ID associated with this set of parameters. Users
  509. // can use this id to determine if the parameters associated with the instance
  510. // differ from the parameters associated with the nodes. A discrepancy between
  511. // parameter ids can inform users that they may need to take action to apply
  512. // parameters on nodes.
  513. string id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  514. // User defined set of parameters to use in the memcached process.
  515. map<string, string> params = 3;
  516. }
  517. // Represents the metadata of a long-running operation.
  518. message OperationMetadata {
  519. // Output only. Time when the operation was created.
  520. google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  521. // Output only. Time when the operation finished running.
  522. google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  523. // Output only. Server-defined resource path for the target of the operation.
  524. string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
  525. // Output only. Name of the verb executed by the operation.
  526. string verb = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
  527. // Output only. Human-readable status of the operation, if any.
  528. string status_detail = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
  529. // Output only. Identifies whether the user has requested cancellation
  530. // of the operation. Operations that have successfully been cancelled
  531. // have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
  532. // corresponding to `Code.CANCELLED`.
  533. bool cancel_requested = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
  534. // Output only. API version used to start the operation.
  535. string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
  536. }
  537. // Metadata for the given [google.cloud.location.Location][google.cloud.location.Location].
  538. message LocationMetadata {
  539. // Output only. The set of available zones in the location. The map is keyed
  540. // by the lowercase ID of each zone, as defined by GCE. These keys can be
  541. // specified in the `zones` field when creating a Memcached instance.
  542. map<string, ZoneMetadata> available_zones = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  543. }
  544. message ZoneMetadata {
  545. }