xref: /aosp_15_r20/external/googleapis/google/cloud/baremetalsolution/v2/osimage.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 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
15syntax = "proto3";
16
17package google.cloud.baremetalsolution.v2;
18
19import "google/api/field_behavior.proto";
20import "google/api/resource.proto";
21
22option csharp_namespace = "Google.Cloud.BareMetalSolution.V2";
23option go_package = "cloud.google.com/go/baremetalsolution/apiv2/baremetalsolutionpb;baremetalsolutionpb";
24option java_multiple_files = true;
25option java_outer_classname = "OsImageProto";
26option java_package = "com.google.cloud.baremetalsolution.v2";
27option php_namespace = "Google\\Cloud\\BareMetalSolution\\V2";
28option ruby_package = "Google::Cloud::BareMetalSolution::V2";
29
30// Operation System image.
31message OSImage {
32  option (google.api.resource) = {
33    type: "baremetalsolution.googleapis.com/OsImage"
34    pattern: "projects/{project}/locations/{location}/osImages/{os_image}"
35    plural: "osImages"
36    singular: "osImage"
37  };
38
39  // Output only. OS Image's unique name.
40  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
41
42  // OS Image code.
43  string code = 2;
44
45  // OS Image description.
46  string description = 3;
47
48  // Instance types this image is applicable to.
49  // [Available
50  // types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
51  repeated string applicable_instance_types = 4;
52
53  // Network templates that can be used with this OS Image.
54  repeated string supported_network_templates = 5;
55}
56
57// Request for getting all available OS images.
58message ListOSImagesRequest {
59  // Required. Parent value for ListProvisioningQuotasRequest.
60  string parent = 1 [
61    (google.api.field_behavior) = REQUIRED,
62    (google.api.resource_reference) = {
63      type: "locations.googleapis.com/Location"
64    }
65  ];
66
67  // Requested page size. The server might return fewer items than requested.
68  // If unspecified, server will pick an appropriate default.
69  // Notice that page_size field is not supported and won't be respected in
70  // the API request for now, will be updated when pagination is supported.
71  int32 page_size = 2;
72
73  // A token identifying a page of results from the server.
74  string page_token = 3;
75}
76
77// Request for getting all available OS images.
78message ListOSImagesResponse {
79  // The OS images available.
80  repeated OSImage os_images = 1;
81
82  // Token to retrieve the next page of results, or empty if there are no more
83  // results in the list.
84  string next_page_token = 2;
85}
86