blob: d69b7f799fb0118c4f91bacc158e9a093240a142 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
// Copyright 2020 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
//
// http://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.
syntax = "proto3";
package google.cloud.osconfig.v1beta;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/cloud/osconfig/v1beta/guest_policies.proto";
import "google/cloud/osconfig/v1beta/patch_deployments.proto";
import "google/cloud/osconfig/v1beta/patch_jobs.proto";
import "google/protobuf/empty.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/osconfig/v1beta;osconfig";
option java_outer_classname = "OsConfigProto";
option java_package = "com.google.cloud.osconfig.v1beta";
// OS Config API
//
// The OS Config service is a server-side component that you can use to
// manage package installations and patch jobs for virtual machine instances.
service OsConfigService {
option (google.api.default_host) = "osconfig.googleapis.com";
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
// Patch VM instances by creating and running a patch job.
rpc ExecutePatchJob(ExecutePatchJobRequest) returns (PatchJob) {
option (google.api.http) = {
post: "/v1beta/{parent=projects/*}/patchJobs:execute"
body: "*"
};
}
// Get the patch job. This can be used to track the progress of an
// ongoing patch job or review the details of completed jobs.
rpc GetPatchJob(GetPatchJobRequest) returns (PatchJob) {
option (google.api.http) = {
get: "/v1beta/{name=projects/*/patchJobs/*}"
};
}
// Cancel a patch job. The patch job must be active. Canceled patch jobs
// cannot be restarted.
rpc CancelPatchJob(CancelPatchJobRequest) returns (PatchJob) {
option (google.api.http) = {
post: "/v1beta/{name=projects/*/patchJobs/*}:cancel"
body: "*"
};
}
// Get a list of patch jobs.
rpc ListPatchJobs(ListPatchJobsRequest) returns (ListPatchJobsResponse) {
option (google.api.http) = {
get: "/v1beta/{parent=projects/*}/patchJobs"
};
}
// Get a list of instance details for a given patch job.
rpc ListPatchJobInstanceDetails(ListPatchJobInstanceDetailsRequest) returns (ListPatchJobInstanceDetailsResponse) {
option (google.api.http) = {
get: "/v1beta/{parent=projects/*/patchJobs/*}/instanceDetails"
};
option (google.api.method_signature) = "parent";
}
// Create an OS Config patch deployment.
rpc CreatePatchDeployment(CreatePatchDeploymentRequest) returns (PatchDeployment) {
option (google.api.http) = {
post: "/v1beta/{parent=projects/*}/patchDeployments"
body: "patch_deployment"
};
}
// Get an OS Config patch deployment.
rpc GetPatchDeployment(GetPatchDeploymentRequest) returns (PatchDeployment) {
option (google.api.http) = {
get: "/v1beta/{name=projects/*/patchDeployments/*}"
};
}
// Get a page of OS Config patch deployments.
rpc ListPatchDeployments(ListPatchDeploymentsRequest) returns (ListPatchDeploymentsResponse) {
option (google.api.http) = {
get: "/v1beta/{parent=projects/*}/patchDeployments"
};
}
// Delete an OS Config patch deployment.
rpc DeletePatchDeployment(DeletePatchDeploymentRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1beta/{name=projects/*/patchDeployments/*}"
};
}
// Update an OS Config patch deployment.
rpc UpdatePatchDeployment(UpdatePatchDeploymentRequest) returns (PatchDeployment) {
option (google.api.http) = {
patch: "/v1beta/{patch_deployment.name=projects/*/patchDeployments/*}"
body: "patch_deployment"
};
option (google.api.method_signature) = "patch_deployment,update_mask";
}
// Change state of patch deployment to "PAUSED".
// Patch deployment in paused state doesn't generate patch jobs.
rpc PausePatchDeployment(PausePatchDeploymentRequest) returns (PatchDeployment) {
option (google.api.http) = {
post: "/v1beta/{name=projects/*/patchDeployments/*}:pause"
body: "*"
};
option (google.api.method_signature) = "name";
}
// Change state of patch deployment back to "ACTIVE".
// Patch deployment in active state continues to generate patch jobs.
rpc ResumePatchDeployment(ResumePatchDeploymentRequest) returns (PatchDeployment) {
option (google.api.http) = {
post: "/v1beta/{name=projects/*/patchDeployments/*}:resume"
body: "*"
};
option (google.api.method_signature) = "name";
}
// Create an OS Config guest policy.
rpc CreateGuestPolicy(CreateGuestPolicyRequest) returns (GuestPolicy) {
option (google.api.http) = {
post: "/v1beta/{parent=projects/*}/guestPolicies"
body: "guest_policy"
};
option (google.api.method_signature) = "parent, guest_policy";
}
// Get an OS Config guest policy.
rpc GetGuestPolicy(GetGuestPolicyRequest) returns (GuestPolicy) {
option (google.api.http) = {
get: "/v1beta/{name=projects/*/guestPolicies/*}"
};
option (google.api.method_signature) = "name";
}
// Get a page of OS Config guest policies.
rpc ListGuestPolicies(ListGuestPoliciesRequest) returns (ListGuestPoliciesResponse) {
option (google.api.http) = {
get: "/v1beta/{parent=projects/*}/guestPolicies"
};
option (google.api.method_signature) = "parent";
}
// Update an OS Config guest policy.
rpc UpdateGuestPolicy(UpdateGuestPolicyRequest) returns (GuestPolicy) {
option (google.api.http) = {
patch: "/v1beta/{guest_policy.name=projects/*/guestPolicies/*}"
body: "guest_policy"
};
option (google.api.method_signature) = "guest_policy,update_mask";
}
// Delete an OS Config guest policy.
rpc DeleteGuestPolicy(DeleteGuestPolicyRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1beta/{name=projects/*/guestPolicies/*}"
};
option (google.api.method_signature) = "name";
}
// Lookup the effective guest policy that applies to a VM instance. This
// lookup merges all policies that are assigned to the instance ancestry.
rpc LookupEffectiveGuestPolicy(LookupEffectiveGuestPolicyRequest) returns (EffectiveGuestPolicy) {
option (google.api.http) = {
post: "/v1beta/{instance=projects/*/zones/*/instances/*}:lookupEffectiveGuestPolicy"
body: "*"
};
}
}
|
