zone_operations.proto

// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Generated by the C++ microgenerator.
// If you make any local changes, they will be lost.
// file:///workspace/generator/discovery/compute_public_google_rest_v1.json
// revision: 20230920

syntax = "proto3";

package google.cloud.cpp.compute.zone_operations.v1;

import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/cloud/compute/v1/internal/common_016.proto";
import "google/cloud/compute/v1/internal/common_083.proto";
import "google/cloud/extended_operations.proto";
import "google/protobuf/empty.proto";

// Service for the zoneOperations resource.
// https://cloud.google.com/compute/docs/reference/rest/v1/zoneOperations
service ZoneOperations {
  option (google.api.default_host) = "compute.googleapis.com";
  option (google.api.oauth_scopes) =
      "https://www.googleapis.com/auth/cloud-platform,"
      "https://www.googleapis.com/auth/compute,"
      "https://www.googleapis.com/auth/compute.readonly";

  // Deletes the specified zone-specific Operations resource.
  // https://cloud.google.com/compute/docs/reference/rest/v1/zoneOperations/delete
  rpc DeleteOperation(DeleteOperationRequest) returns (google.protobuf.Empty) {
    option (google.api.http) = {
      delete: "/compute/v1/projects/{project}/zones/{zone}/operations/{operation}"
    };
    option (google.api.method_signature) = "project,zone,operation";
  }

  // Retrieves the specified zone-specific Operations resource.
  // https://cloud.google.com/compute/docs/reference/rest/v1/zoneOperations/get
  rpc GetOperation(GetOperationRequest)
      returns (google.cloud.cpp.compute.v1.Operation) {
    option (google.api.http) = {
      get: "/compute/v1/projects/{project}/zones/{zone}/operations/{operation}"
    };
    option (google.api.method_signature) = "project,zone,operation";
  }

  // Retrieves a list of Operation resources contained within the specified
  // zone.
  // https://cloud.google.com/compute/docs/reference/rest/v1/zoneOperations/list
  rpc ListZoneOperations(ListZoneOperationsRequest)
      returns (google.cloud.cpp.compute.v1.OperationList) {
    option (google.api.http) = {
      get: "/compute/v1/projects/{project}/zones/{zone}/operations"
    };
    option (google.api.method_signature) = "project,zone";
  }

  // Waits for the specified Operation resource to return as `DONE` or for the
  // request to approach the 2 minute deadline, and retrieves the specified
  // Operation resource. This method waits for no more than the 2 minutes and
  // then returns the current state of the operation, which might be `DONE` or
  // still in progress. This method is called on a best-effort basis.
  // Specifically: - In uncommon cases, when the server is overloaded, the
  // request might return before the default deadline is reached, or might
  // return after zero seconds. - If the default deadline is reached, there is
  // no guarantee that the operation is actually done when the method returns.
  // Be prepared to retry if the operation is not `DONE`.
  // https://cloud.google.com/compute/docs/reference/rest/v1/zoneOperations/wait
  rpc Wait(WaitRequest) returns (google.cloud.cpp.compute.v1.Operation) {
    option (google.api.http) = {
      post: "/compute/v1/projects/{project}/zones/{zone}/operations/{operation}/wait"
      body: "*"
    };
    option (google.api.method_signature) = "project,zone,operation";
  }
}

// Request message for DeleteOperation.
message DeleteOperationRequest {
  // Name of the Operations resource to delete.
  string operation = 1 [(google.api.field_behavior) = REQUIRED];

  // Project ID for this request.
  string project = 2 [(google.api.field_behavior) = REQUIRED];

  // Name of the zone for this request.
  string zone = 3 [(google.api.field_behavior) = REQUIRED];
}

// Request message for GetOperation.
message GetOperationRequest {
  // Name of the Operations resource to return.
  string operation = 1 [(google.api.field_behavior) = REQUIRED];

  // Project ID for this request.
  string project = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.cloud.operation_request_field) = "project"
  ];

  // Name of the zone for this request.
  string zone = 3 [
    (google.api.field_behavior) = REQUIRED,
    (google.cloud.operation_request_field) = "zone"
  ];
}

// Request message for ListZoneOperations.
message ListZoneOperationsRequest {
  // A filter expression that filters resources listed in the response. Most
  // Compute resources support two types of filter expressions: expressions that
  // support regular expressions and expressions that follow API improvement
  // proposal AIP-160. These two types of filter expressions cannot be mixed in
  // one request. If you want to use AIP-160, your expression must specify the
  // field name, an operator, and the value that you want to use for filtering.
  // The value must be a string, a number, or a boolean. The operator must be
  // either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are
  // filtering Compute Engine instances, you can exclude instances named
  // `example-instance` by specifying `name != example-instance`. The `:*`
  // comparison can be used to test whether a key has been defined. For example,
  // to find all objects with `owner` label use: ``` labels.owner:* ``` You can
  // also filter nested fields. For example, you could specify
  // `scheduling.automaticRestart = false` to include instances only if they are
  // not scheduled for automatic restarts. You can use filtering on nested
  // fields to filter based on resource labels. To filter on multiple
  // expressions, provide each separate expression within parentheses. For
  // example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel
  // Skylake") ``` By default, each expression is an `AND` expression. However,
  // you can include `AND` and `OR` expressions explicitly. For example: ```
  // (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND
  // (scheduling.automaticRestart = true) ``` If you want to use a regular
  // expression, use the `eq` (equal) or `ne` (not equal) operator against a
  // single un-parenthesized expression with or without quotes or against
  // multiple parenthesized expressions. Examples: `fieldname eq unquoted
  // literal` `fieldname eq 'single quoted literal'` `fieldname eq "double
  // quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The
  // literal value is interpreted as a regular expression using Google RE2
  // library syntax. The literal value must match the entire field. For example,
  // to filter for instances that do not end with name "instance", you would use
  // `name ne .*instance`. You cannot combine constraints on multiple fields
  // using regular expressions.
  optional string filter = 1;

  // The maximum number of results per page that should be returned. If the
  // number of available results is larger than `maxResults`, Compute Engine
  // returns a `nextPageToken` that can be used to get the next page of results
  // in subsequent list requests. Acceptable values are `0` to `500`, inclusive.
  // (Default: `500`)
  optional uint32 max_results = 2;

  // Sorts list results by a certain order. By default, results are returned in
  // alphanumerical order based on the resource name. You can also sort results
  // in descending order based on the creation timestamp using
  // `orderBy="creationTimestamp desc"`. This sorts results based on the
  // `creationTimestamp` field in reverse chronological order (newest result
  // first). Use this to sort resources like operations so that the newest
  // operation is returned first. Currently, only sorting by `name` or
  // `creationTimestamp desc` is supported.
  optional string order_by = 3;

  // Specifies a page token to use. Set `pageToken` to the `nextPageToken`
  // returned by a previous list request to get the next page of results.
  optional string page_token = 4;

  // Project ID for this request.
  string project = 5 [(google.api.field_behavior) = REQUIRED];

  // Opt-in for partial success behavior which provides partial results in case
  // of failure. The default value is false.
  optional bool return_partial_success = 6;

  // Name of the zone for request.
  string zone = 7 [(google.api.field_behavior) = REQUIRED];
}

// Request message for Wait.
message WaitRequest {
  // Name of the Operations resource to return.
  string operation = 1 [(google.api.field_behavior) = REQUIRED];

  // Project ID for this request.
  string project = 2 [
    (google.api.field_behavior) = REQUIRED,
    (google.cloud.operation_request_field) = "project"
  ];

  // Name of the zone for this request.
  string zone = 3 [
    (google.api.field_behavior) = REQUIRED,
    (google.cloud.operation_request_field) = "zone"
  ];
}