routers.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.routers.v1;

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

// Service for the routers resource.
// https://cloud.google.com/compute/docs/reference/rest/v1/routers
service Routers {
  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";

  // Retrieves an aggregated list of routers.
  // https://cloud.google.com/compute/docs/reference/rest/v1/routers/aggregatedList
  rpc AggregatedListRouters(AggregatedListRoutersRequest)
      returns (google.cloud.cpp.compute.v1.RouterAggregatedList) {
    option (google.api.http) = {
      get: "/compute/v1/projects/{project}/aggregated/routers"
    };
    option (google.api.method_signature) = "project";
  }

  // Deletes the specified Router resource.
  // https://cloud.google.com/compute/docs/reference/rest/v1/routers/delete
  rpc DeleteRouter(DeleteRouterRequest)
      returns (google.cloud.cpp.compute.v1.Operation) {
    option (google.api.http) = {
      delete: "/compute/v1/projects/{project}/regions/{region}/routers/{router}"
    };
    option (google.api.method_signature) = "project,region,router";
    option (google.cloud.operation_service) = "RegionOperations";
  }

  // Returns the specified Router resource.
  // https://cloud.google.com/compute/docs/reference/rest/v1/routers/get
  rpc GetRouter(GetRouterRequest) returns (google.cloud.cpp.compute.v1.Router) {
    option (google.api.http) = {
      get: "/compute/v1/projects/{project}/regions/{region}/routers/{router}"
    };
    option (google.api.method_signature) = "project,region,router";
  }

  // Retrieves runtime NAT IP information.
  // https://cloud.google.com/compute/docs/reference/rest/v1/routers/getNatIpInfo
  rpc GetNatIpInfo(GetNatIpInfoRequest)
      returns (google.cloud.cpp.compute.v1.NatIpInfoResponse) {
    option (google.api.http) = {
      get: "/compute/v1/projects/{project}/regions/{region}/routers/{router}/getNatIpInfo"
    };
    option (google.api.method_signature) = "project,region,router";
  }

  // Retrieves runtime Nat mapping information of VM endpoints.
  // https://cloud.google.com/compute/docs/reference/rest/v1/routers/getNatMappingInfo
  rpc GetNatMappingInfo(GetNatMappingInfoRequest)
      returns (google.cloud.cpp.compute.v1.VmEndpointNatMappingsList) {
    option (google.api.http) = {
      get: "/compute/v1/projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo"
    };
    option (google.api.method_signature) = "project,region,router";
  }

  // Retrieves runtime information of the specified router.
  // https://cloud.google.com/compute/docs/reference/rest/v1/routers/getRouterStatus
  rpc GetRouterStatus(GetRouterStatusRequest)
      returns (google.cloud.cpp.compute.v1.RouterStatusResponse) {
    option (google.api.http) = {
      get: "/compute/v1/projects/{project}/regions/{region}/routers/{router}/getRouterStatus"
    };
    option (google.api.method_signature) = "project,region,router";
  }

  // Creates a Router resource in the specified project and region using the
  // data included in the request.
  // https://cloud.google.com/compute/docs/reference/rest/v1/routers/insert
  rpc InsertRouter(InsertRouterRequest)
      returns (google.cloud.cpp.compute.v1.Operation) {
    option (google.api.http) = {
      post: "/compute/v1/projects/{project}/regions/{region}/routers"
      body: "router_resource"
    };
    option (google.api.method_signature) = "project,region,router_resource";
    option (google.cloud.operation_service) = "RegionOperations";
  }

  // Retrieves a list of Router resources available to the specified project.
  // https://cloud.google.com/compute/docs/reference/rest/v1/routers/list
  rpc ListRouters(ListRoutersRequest)
      returns (google.cloud.cpp.compute.v1.RouterList) {
    option (google.api.http) = {
      get: "/compute/v1/projects/{project}/regions/{region}/routers"
    };
    option (google.api.method_signature) = "project,region";
  }

  // Patches the specified Router resource with the data included in the
  // request. This method supports PATCH semantics and uses JSON merge patch
  // format and processing rules.
  // https://cloud.google.com/compute/docs/reference/rest/v1/routers/patch
  rpc PatchRouter(PatchRouterRequest)
      returns (google.cloud.cpp.compute.v1.Operation) {
    option (google.api.http) = {
      patch: "/compute/v1/projects/{project}/regions/{region}/routers/{router}"
      body: "router_resource"
    };
    option (google.api.method_signature) =
        "project,region,router,router_resource";
    option (google.cloud.operation_service) = "RegionOperations";
  }

  // Preview fields auto-generated during router create and update operations.
  // Calling this method does NOT create or update the router.
  // https://cloud.google.com/compute/docs/reference/rest/v1/routers/preview
  rpc Preview(PreviewRequest)
      returns (google.cloud.cpp.compute.v1.RoutersPreviewResponse) {
    option (google.api.http) = {
      post: "/compute/v1/projects/{project}/regions/{region}/routers/{router}/preview"
      body: "router_resource"
    };
    option (google.api.method_signature) =
        "project,region,router,router_resource";
  }

  // Updates the specified Router resource with the data included in the
  // request. This method conforms to PUT semantics, which requests that the
  // state of the target resource be created or replaced with the state defined
  // by the representation enclosed in the request message payload.
  // https://cloud.google.com/compute/docs/reference/rest/v1/routers/update
  rpc UpdateRouter(UpdateRouterRequest)
      returns (google.cloud.cpp.compute.v1.Operation) {
    option (google.api.http) = {
      put: "/compute/v1/projects/{project}/regions/{region}/routers/{router}"
      body: "router_resource"
    };
    option (google.api.method_signature) =
        "project,region,router,router_resource";
    option (google.cloud.operation_service) = "RegionOperations";
  }
}

// Request message for AggregatedListRouters.
message AggregatedListRoutersRequest {
  // 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;

  // Indicates whether every visible scope for each scope type (zone, region,
  // global) should be included in the response. For new resource types added
  // after this field, the flag has no effect as new resource types will always
  // include every visible scope for each scope type in response. For resource
  // types which predate this field, if this flag is omitted or false, only
  // scopes of the scope types where the resource type is expected to be found
  // will be included.
  optional bool include_all_scopes = 2;

  // 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 = 3;

  // 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 = 4;

  // 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 = 5;

  // Project ID for this request.
  string project = 6 [(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 = 7;

  optional string service_project_number = 8;
}

// Request message for DeleteRouter.
message DeleteRouterRequest {
  // Project ID for this request.
  string project = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.cloud.operation_request_field) = "project"
  ];

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

  // An optional request ID to identify requests. Specify a unique request ID so
  // that if you must retry your request, the server will know to ignore the
  // request if it has already been completed. For example, consider a situation
  // where you make an initial request and the request times out. If you make
  // the request again with the same request ID, the server can check if
  // original operation with the same request ID was received, and if so, will
  // ignore the second request. This prevents clients from accidentally creating
  // duplicate commitments. The request ID must be a valid UUID with the
  // exception that zero UUID is not supported (
  // 00000000-0000-0000-0000-000000000000).
  optional string request_id = 3;

  // Name of the Router resource to delete.
  string router = 4 [(google.api.field_behavior) = REQUIRED];
}

// Request message for GetNatIpInfo.
message GetNatIpInfoRequest {
  // Name of the nat service to filter the NAT IP information. If it is omitted,
  // all nats for this router will be returned. Name should conform to RFC1035.
  optional string nat_name = 1;

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

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

  // Name of the Router resource to query for Nat IP information. The name
  // should conform to RFC1035.
  string router = 4 [(google.api.field_behavior) = REQUIRED];
}

// Request message for GetNatMappingInfo.
message GetNatMappingInfoRequest {
  // 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;

  // Name of the nat service to filter the Nat Mapping information. If it is
  // omitted, all nats for this router will be returned. Name should conform to
  // RFC1035.
  optional string nat_name = 3;

  // 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 = 4;

  // 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 = 5;

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

  // Name of the region for this request.
  string region = 7 [(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 = 8;

  // Name of the Router resource to query for Nat Mapping information of VM
  // endpoints.
  string router = 9 [(google.api.field_behavior) = REQUIRED];
}

// Request message for GetRouter.
message GetRouterRequest {
  // Project ID for this request.
  string project = 1 [(google.api.field_behavior) = REQUIRED];

  // Name of the region for this request.
  string region = 2 [(google.api.field_behavior) = REQUIRED];

  // Name of the Router resource to return.
  string router = 3 [(google.api.field_behavior) = REQUIRED];
}

// Request message for GetRouterStatus.
message GetRouterStatusRequest {
  // Project ID for this request.
  string project = 1 [(google.api.field_behavior) = REQUIRED];

  // Name of the region for this request.
  string region = 2 [(google.api.field_behavior) = REQUIRED];

  // Name of the Router resource to query.
  string router = 3 [(google.api.field_behavior) = REQUIRED];
}

// Request message for InsertRouter.
message InsertRouterRequest {
  // Project ID for this request.
  string project = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.cloud.operation_request_field) = "project"
  ];

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

  // An optional request ID to identify requests. Specify a unique request ID so
  // that if you must retry your request, the server will know to ignore the
  // request if it has already been completed. For example, consider a situation
  // where you make an initial request and the request times out. If you make
  // the request again with the same request ID, the server can check if
  // original operation with the same request ID was received, and if so, will
  // ignore the second request. This prevents clients from accidentally creating
  // duplicate commitments. The request ID must be a valid UUID with the
  // exception that zero UUID is not supported (
  // 00000000-0000-0000-0000-000000000000).
  optional string request_id = 3;

  // The Router for this request.
  optional google.cloud.cpp.compute.v1.Router router_resource = 4
      [json_name = "__json_request_body"];
}

// Request message for ListRouters.
message ListRoutersRequest {
  // 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];

  // Name of the region for this request.
  string region = 6 [(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 = 7;
}

// Request message for PatchRouter.
message PatchRouterRequest {
  // Project ID for this request.
  string project = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.cloud.operation_request_field) = "project"
  ];

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

  // An optional request ID to identify requests. Specify a unique request ID so
  // that if you must retry your request, the server will know to ignore the
  // request if it has already been completed. For example, consider a situation
  // where you make an initial request and the request times out. If you make
  // the request again with the same request ID, the server can check if
  // original operation with the same request ID was received, and if so, will
  // ignore the second request. This prevents clients from accidentally creating
  // duplicate commitments. The request ID must be a valid UUID with the
  // exception that zero UUID is not supported (
  // 00000000-0000-0000-0000-000000000000).
  optional string request_id = 3;

  // Name of the Router resource to patch.
  string router = 4 [(google.api.field_behavior) = REQUIRED];

  // The Router for this request.
  optional google.cloud.cpp.compute.v1.Router router_resource = 5
      [json_name = "__json_request_body"];
}

// Request message for Preview.
message PreviewRequest {
  // Project ID for this request.
  string project = 1 [(google.api.field_behavior) = REQUIRED];

  // Name of the region for this request.
  string region = 2 [(google.api.field_behavior) = REQUIRED];

  // Name of the Router resource to query.
  string router = 3 [(google.api.field_behavior) = REQUIRED];

  // The Router for this request.
  optional google.cloud.cpp.compute.v1.Router router_resource = 4
      [json_name = "__json_request_body"];
}

// Request message for UpdateRouter.
message UpdateRouterRequest {
  // Project ID for this request.
  string project = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.cloud.operation_request_field) = "project"
  ];

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

  // An optional request ID to identify requests. Specify a unique request ID so
  // that if you must retry your request, the server will know to ignore the
  // request if it has already been completed. For example, consider a situation
  // where you make an initial request and the request times out. If you make
  // the request again with the same request ID, the server can check if
  // original operation with the same request ID was received, and if so, will
  // ignore the second request. This prevents clients from accidentally creating
  // duplicate commitments. The request ID must be a valid UUID with the
  // exception that zero UUID is not supported (
  // 00000000-0000-0000-0000-000000000000).
  optional string request_id = 3;

  // Name of the Router resource to update.
  string router = 4 [(google.api.field_behavior) = REQUIRED];

  // The Router for this request.
  optional google.cloud.cpp.compute.v1.Router router_resource = 5
      [json_name = "__json_request_body"];
}