google-cloud-cloud_controls_partner-v1 0.a → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_core/client.rb +1171 -0
  6. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_core/credentials.rb +47 -0
  7. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_core/paths.rb +149 -0
  8. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_core/rest/client.rb +1084 -0
  9. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_core/rest/service_stub.rb +541 -0
  10. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_core/rest.rb +52 -0
  11. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_core.rb +55 -0
  12. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/client.rb +556 -0
  13. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/credentials.rb +47 -0
  14. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/paths.rb +77 -0
  15. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/rest/client.rb +515 -0
  16. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/rest/service_stub.rb +187 -0
  17. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring/rest.rb +52 -0
  18. data/lib/google/cloud/cloud_controls_partner/v1/cloud_controls_partner_monitoring.rb +55 -0
  19. data/lib/google/cloud/cloud_controls_partner/v1/rest.rb +38 -0
  20. data/lib/google/cloud/cloud_controls_partner/v1/version.rb +7 -2
  21. data/lib/google/cloud/cloud_controls_partner/v1.rb +46 -0
  22. data/lib/google/cloud/cloudcontrolspartner/v1/access_approval_requests_pb.rb +51 -0
  23. data/lib/google/cloud/cloudcontrolspartner/v1/completion_state_pb.rb +42 -0
  24. data/lib/google/cloud/cloudcontrolspartner/v1/core_pb.rb +55 -0
  25. data/lib/google/cloud/cloudcontrolspartner/v1/core_services_pb.rb +60 -0
  26. data/lib/google/cloud/cloudcontrolspartner/v1/customer_workloads_pb.rb +55 -0
  27. data/lib/google/cloud/cloudcontrolspartner/v1/customers_pb.rb +54 -0
  28. data/lib/google/cloud/cloudcontrolspartner/v1/ekm_connections_pb.rb +49 -0
  29. data/lib/google/cloud/cloudcontrolspartner/v1/monitoring_pb.rb +45 -0
  30. data/lib/google/cloud/cloudcontrolspartner/v1/monitoring_services_pb.rb +53 -0
  31. data/lib/google/cloud/cloudcontrolspartner/v1/partner_permissions_pb.rb +47 -0
  32. data/lib/google/cloud/cloudcontrolspartner/v1/partners_pb.rb +51 -0
  33. data/lib/google/cloud/cloudcontrolspartner/v1/violations_pb.rb +58 -0
  34. data/lib/google-cloud-cloud_controls_partner-v1.rb +21 -0
  35. data/proto_docs/README.md +4 -0
  36. data/proto_docs/google/api/client.rb +399 -0
  37. data/proto_docs/google/api/field_behavior.rb +85 -0
  38. data/proto_docs/google/api/launch_stage.rb +71 -0
  39. data/proto_docs/google/api/resource.rb +222 -0
  40. data/proto_docs/google/cloud/cloudcontrolspartner/v1/access_approval_requests.rb +143 -0
  41. data/proto_docs/google/cloud/cloudcontrolspartner/v1/completion_state.rb +44 -0
  42. data/proto_docs/google/cloud/cloudcontrolspartner/v1/core.rb +57 -0
  43. data/proto_docs/google/cloud/cloudcontrolspartner/v1/customer_workloads.rb +177 -0
  44. data/proto_docs/google/cloud/cloudcontrolspartner/v1/customers.rb +134 -0
  45. data/proto_docs/google/cloud/cloudcontrolspartner/v1/ekm_connections.rb +96 -0
  46. data/proto_docs/google/cloud/cloudcontrolspartner/v1/partner_permissions.rb +66 -0
  47. data/proto_docs/google/cloud/cloudcontrolspartner/v1/partners.rb +117 -0
  48. data/proto_docs/google/cloud/cloudcontrolspartner/v1/violations.rb +229 -0
  49. data/proto_docs/google/protobuf/duration.rb +98 -0
  50. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  51. data/proto_docs/google/type/interval.rb +45 -0
  52. metadata +93 -10
@@ -0,0 +1,222 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # A simple descriptor of a resource type.
23
+ #
24
+ # ResourceDescriptor annotates a resource message (either by means of a
25
+ # protobuf annotation or use in the service config), and associates the
26
+ # resource's schema, the resource type, and the pattern of the resource name.
27
+ #
28
+ # Example:
29
+ #
30
+ # message Topic {
31
+ # // Indicates this message defines a resource schema.
32
+ # // Declares the resource type in the format of {service}/{kind}.
33
+ # // For Kubernetes resources, the format is {api group}/{kind}.
34
+ # option (google.api.resource) = {
35
+ # type: "pubsub.googleapis.com/Topic"
36
+ # pattern: "projects/{project}/topics/{topic}"
37
+ # };
38
+ # }
39
+ #
40
+ # The ResourceDescriptor Yaml config will look like:
41
+ #
42
+ # resources:
43
+ # - type: "pubsub.googleapis.com/Topic"
44
+ # pattern: "projects/{project}/topics/{topic}"
45
+ #
46
+ # Sometimes, resources have multiple patterns, typically because they can
47
+ # live under multiple parents.
48
+ #
49
+ # Example:
50
+ #
51
+ # message LogEntry {
52
+ # option (google.api.resource) = {
53
+ # type: "logging.googleapis.com/LogEntry"
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
58
+ # };
59
+ # }
60
+ #
61
+ # The ResourceDescriptor Yaml config will look like:
62
+ #
63
+ # resources:
64
+ # - type: 'logging.googleapis.com/LogEntry'
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
69
+ # @!attribute [rw] type
70
+ # @return [::String]
71
+ # The resource type. It must be in the format of
72
+ # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
73
+ # singular and must not include version numbers.
74
+ #
75
+ # Example: `storage.googleapis.com/Bucket`
76
+ #
77
+ # The value of the resource_type_kind must follow the regular expression
78
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
79
+ # should use PascalCase (UpperCamelCase). The maximum number of
80
+ # characters allowed for the `resource_type_kind` is 100.
81
+ # @!attribute [rw] pattern
82
+ # @return [::Array<::String>]
83
+ # Optional. The relative resource name pattern associated with this resource
84
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
85
+ #
86
+ # The path pattern must follow the syntax, which aligns with HTTP binding
87
+ # syntax:
88
+ #
89
+ # Template = Segment { "/" Segment } ;
90
+ # Segment = LITERAL | Variable ;
91
+ # Variable = "{" LITERAL "}" ;
92
+ #
93
+ # Examples:
94
+ #
95
+ # - "projects/\\{project}/topics/\\{topic}"
96
+ # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
97
+ #
98
+ # The components in braces correspond to the IDs for each resource in the
99
+ # hierarchy. It is expected that, if multiple patterns are provided,
100
+ # the same component name (e.g. "project") refers to IDs of the same
101
+ # type of resource.
102
+ # @!attribute [rw] name_field
103
+ # @return [::String]
104
+ # Optional. The field on the resource that designates the resource name
105
+ # field. If omitted, this is assumed to be "name".
106
+ # @!attribute [rw] history
107
+ # @return [::Google::Api::ResourceDescriptor::History]
108
+ # Optional. The historical or future-looking state of the resource pattern.
109
+ #
110
+ # Example:
111
+ #
112
+ # // The InspectTemplate message originally only supported resource
113
+ # // names with organization, and project was added later.
114
+ # message InspectTemplate {
115
+ # option (google.api.resource) = {
116
+ # type: "dlp.googleapis.com/InspectTemplate"
117
+ # pattern:
118
+ # "organizations/{organization}/inspectTemplates/{inspect_template}"
119
+ # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
120
+ # history: ORIGINALLY_SINGLE_PATTERN
121
+ # };
122
+ # }
123
+ # @!attribute [rw] plural
124
+ # @return [::String]
125
+ # The plural name used in the resource name and permission names, such as
126
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
128
+ # concept of the `plural` field in k8s CRD spec
129
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
130
+ #
131
+ # Note: The plural form is required even for singleton resources. See
132
+ # https://aip.dev/156
133
+ # @!attribute [rw] singular
134
+ # @return [::String]
135
+ # The same concept of the `singular` field in k8s CRD spec
136
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
137
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
138
+ # @!attribute [rw] style
139
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
140
+ # Style flag(s) for this resource.
141
+ # These indicate that a resource is expected to conform to a given
142
+ # style. See the specific style flags for additional information.
143
+ class ResourceDescriptor
144
+ include ::Google::Protobuf::MessageExts
145
+ extend ::Google::Protobuf::MessageExts::ClassMethods
146
+
147
+ # A description of the historical or future-looking state of the
148
+ # resource pattern.
149
+ module History
150
+ # The "unset" value.
151
+ HISTORY_UNSPECIFIED = 0
152
+
153
+ # The resource originally had one pattern and launched as such, and
154
+ # additional patterns were added later.
155
+ ORIGINALLY_SINGLE_PATTERN = 1
156
+
157
+ # The resource has one pattern, but the API owner expects to add more
158
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
159
+ # that from being necessary once there are multiple patterns.)
160
+ FUTURE_MULTI_PATTERN = 2
161
+ end
162
+
163
+ # A flag representing a specific style that a resource claims to conform to.
164
+ module Style
165
+ # The unspecified value. Do not use.
166
+ STYLE_UNSPECIFIED = 0
167
+
168
+ # This resource is intended to be "declarative-friendly".
169
+ #
170
+ # Declarative-friendly resources must be more strictly consistent, and
171
+ # setting this to true communicates to tools that this resource should
172
+ # adhere to declarative-friendly expectations.
173
+ #
174
+ # Note: This is used by the API linter (linter.aip.dev) to enable
175
+ # additional checks.
176
+ DECLARATIVE_FRIENDLY = 1
177
+ end
178
+ end
179
+
180
+ # Defines a proto annotation that describes a string field that refers to
181
+ # an API resource.
182
+ # @!attribute [rw] type
183
+ # @return [::String]
184
+ # The resource type that the annotated field references.
185
+ #
186
+ # Example:
187
+ #
188
+ # message Subscription {
189
+ # string topic = 2 [(google.api.resource_reference) = {
190
+ # type: "pubsub.googleapis.com/Topic"
191
+ # }];
192
+ # }
193
+ #
194
+ # Occasionally, a field may reference an arbitrary resource. In this case,
195
+ # APIs use the special value * in their resource reference.
196
+ #
197
+ # Example:
198
+ #
199
+ # message GetIamPolicyRequest {
200
+ # string resource = 2 [(google.api.resource_reference) = {
201
+ # type: "*"
202
+ # }];
203
+ # }
204
+ # @!attribute [rw] child_type
205
+ # @return [::String]
206
+ # The resource type of a child collection that the annotated field
207
+ # references. This is useful for annotating the `parent` field that
208
+ # doesn't have a fixed resource type.
209
+ #
210
+ # Example:
211
+ #
212
+ # message ListLogEntriesRequest {
213
+ # string parent = 1 [(google.api.resource_reference) = {
214
+ # child_type: "logging.googleapis.com/LogEntry"
215
+ # };
216
+ # }
217
+ class ResourceReference
218
+ include ::Google::Protobuf::MessageExts
219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
220
+ end
221
+ end
222
+ end
@@ -0,0 +1,143 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module CloudControlsPartner
23
+ module V1
24
+ # Details about the Access request.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Identifier. Format:
28
+ # `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/accessApprovalRequests/{access_approval_request}`
29
+ # @!attribute [rw] request_time
30
+ # @return [::Google::Protobuf::Timestamp]
31
+ # The time at which approval was requested.
32
+ # @!attribute [rw] requested_reason
33
+ # @return [::Google::Cloud::CloudControlsPartner::V1::AccessReason]
34
+ # The justification for which approval is being requested.
35
+ # @!attribute [rw] requested_expiration_time
36
+ # @return [::Google::Protobuf::Timestamp]
37
+ # The requested expiration for the approval. If the request is approved,
38
+ # access will be granted from the time of approval until the expiration time.
39
+ class AccessApprovalRequest
40
+ include ::Google::Protobuf::MessageExts
41
+ extend ::Google::Protobuf::MessageExts::ClassMethods
42
+ end
43
+
44
+ # Request for getting the access requests associated with a workload.
45
+ # @!attribute [rw] parent
46
+ # @return [::String]
47
+ # Required. Parent resource
48
+ # Format:
49
+ # `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`
50
+ # @!attribute [rw] page_size
51
+ # @return [::Integer]
52
+ # Optional. The maximum number of access requests to return. The service may
53
+ # return fewer than this value. If unspecified, at most 500 access requests
54
+ # will be returned.
55
+ # @!attribute [rw] page_token
56
+ # @return [::String]
57
+ # Optional. A page token, received from a previous
58
+ # `ListAccessApprovalRequests` call. Provide this to retrieve the subsequent
59
+ # page.
60
+ # @!attribute [rw] filter
61
+ # @return [::String]
62
+ # Optional. Filtering results.
63
+ # @!attribute [rw] order_by
64
+ # @return [::String]
65
+ # Optional. Hint for how to order the results.
66
+ class ListAccessApprovalRequestsRequest
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+ end
70
+
71
+ # Response message for list access requests.
72
+ # @!attribute [rw] access_approval_requests
73
+ # @return [::Array<::Google::Cloud::CloudControlsPartner::V1::AccessApprovalRequest>]
74
+ # List of access approval requests
75
+ # @!attribute [rw] next_page_token
76
+ # @return [::String]
77
+ # A token that can be sent as `page_token` to retrieve the next page.
78
+ # If this field is omitted, there are no subsequent pages.
79
+ # @!attribute [rw] unreachable
80
+ # @return [::Array<::String>]
81
+ # Locations that could not be reached.
82
+ class ListAccessApprovalRequestsResponse
83
+ include ::Google::Protobuf::MessageExts
84
+ extend ::Google::Protobuf::MessageExts::ClassMethods
85
+ end
86
+
87
+ # Reason for the access.
88
+ # @!attribute [rw] type
89
+ # @return [::Google::Cloud::CloudControlsPartner::V1::AccessReason::Type]
90
+ # Type of access justification.
91
+ # @!attribute [rw] detail
92
+ # @return [::String]
93
+ # More detail about certain reason types. See comments for each type above.
94
+ class AccessReason
95
+ include ::Google::Protobuf::MessageExts
96
+ extend ::Google::Protobuf::MessageExts::ClassMethods
97
+
98
+ # Type of access justification.
99
+ module Type
100
+ # Default value for proto, shouldn't be used.
101
+ TYPE_UNSPECIFIED = 0
102
+
103
+ # Customer made a request or raised an issue that required the principal to
104
+ # access customer data. `detail` is of the form ("#####" is the issue ID):
105
+ #
106
+ # - "Feedback Report: #####"
107
+ # - "Case Number: #####"
108
+ # - "Case ID: #####"
109
+ # - "E-PIN Reference: #####"
110
+ # - "Google-#####"
111
+ # - "T-#####"
112
+ CUSTOMER_INITIATED_SUPPORT = 1
113
+
114
+ # The principal accessed customer data in order to diagnose or resolve a
115
+ # suspected issue in services. Often this access is used to confirm that
116
+ # customers are not affected by a suspected service issue or to remediate a
117
+ # reversible system issue.
118
+ GOOGLE_INITIATED_SERVICE = 2
119
+
120
+ # Google initiated service for security, fraud, abuse, or compliance
121
+ # purposes.
122
+ GOOGLE_INITIATED_REVIEW = 3
123
+
124
+ # The principal was compelled to access customer data in order to respond
125
+ # to a legal third party data request or process, including legal processes
126
+ # from customers themselves.
127
+ THIRD_PARTY_DATA_REQUEST = 4
128
+
129
+ # The principal accessed customer data in order to diagnose or resolve a
130
+ # suspected issue in services or a known outage.
131
+ GOOGLE_RESPONSE_TO_PRODUCTION_ALERT = 5
132
+
133
+ # Similar to 'GOOGLE_INITIATED_SERVICE' or 'GOOGLE_INITIATED_REVIEW', but
134
+ # with universe agnostic naming. The principal accessed customer data in
135
+ # order to diagnose or resolve a suspected issue in services or a known
136
+ # outage, or for security, fraud, abuse, or compliance review purposes.
137
+ CLOUD_INITIATED_ACCESS = 6
138
+ end
139
+ end
140
+ end
141
+ end
142
+ end
143
+ end
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module CloudControlsPartner
23
+ module V1
24
+ # Enum for possible completion states.
25
+ module CompletionState
26
+ # Unspecified completion state.
27
+ COMPLETION_STATE_UNSPECIFIED = 0
28
+
29
+ # Task started (has start date) but not yet completed.
30
+ PENDING = 1
31
+
32
+ # Succeeded state.
33
+ SUCCEEDED = 2
34
+
35
+ # Failed state.
36
+ FAILED = 3
37
+
38
+ # Not applicable state.
39
+ NOT_APPLICABLE = 4
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,57 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module CloudControlsPartner
23
+ module V1
24
+ # Represents the metadata of the long-running operation.
25
+ # @!attribute [r] create_time
26
+ # @return [::Google::Protobuf::Timestamp]
27
+ # Output only. The time the operation was created.
28
+ # @!attribute [r] end_time
29
+ # @return [::Google::Protobuf::Timestamp]
30
+ # Output only. The time the operation finished running.
31
+ # @!attribute [r] target
32
+ # @return [::String]
33
+ # Output only. Server-defined resource path for the target of the operation.
34
+ # @!attribute [r] verb
35
+ # @return [::String]
36
+ # Output only. Name of the verb executed by the operation.
37
+ # @!attribute [r] status_message
38
+ # @return [::String]
39
+ # Output only. Human-readable status of the operation, if any.
40
+ # @!attribute [r] requested_cancellation
41
+ # @return [::Boolean]
42
+ # Output only. Identifies whether the user has requested cancellation
43
+ # of the operation. Operations that have been cancelled successfully
44
+ # have [Operation.error][] value with a
45
+ # [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
46
+ # `Code.CANCELLED`.
47
+ # @!attribute [r] api_version
48
+ # @return [::String]
49
+ # Output only. API version used to start the operation.
50
+ class OperationMetadata
51
+ include ::Google::Protobuf::MessageExts
52
+ extend ::Google::Protobuf::MessageExts::ClassMethods
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,177 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module CloudControlsPartner
23
+ module V1
24
+ # Contains metadata around the [Workload
25
+ # resource](https://cloud.google.com/assured-workloads/docs/reference/rest/Shared.Types/Workload)
26
+ # in the Assured Workloads API.
27
+ # @!attribute [rw] name
28
+ # @return [::String]
29
+ # Identifier. Format:
30
+ # `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`
31
+ # @!attribute [r] folder_id
32
+ # @return [::Integer]
33
+ # Output only. Folder id this workload is associated with
34
+ # @!attribute [r] create_time
35
+ # @return [::Google::Protobuf::Timestamp]
36
+ # Output only. Time the resource was created.
37
+ # @!attribute [r] folder
38
+ # @return [::String]
39
+ # Output only. The name of container folder of the assured workload
40
+ # @!attribute [rw] workload_onboarding_state
41
+ # @return [::Google::Cloud::CloudControlsPartner::V1::WorkloadOnboardingState]
42
+ # Container for workload onboarding steps.
43
+ # @!attribute [rw] is_onboarded
44
+ # @return [::Boolean]
45
+ # Indicates whether a workload is fully onboarded.
46
+ # @!attribute [rw] key_management_project_id
47
+ # @return [::String]
48
+ # The project id of the key management project for the workload
49
+ # @!attribute [rw] location
50
+ # @return [::String]
51
+ # The Google Cloud location of the workload
52
+ # @!attribute [rw] partner
53
+ # @return [::Google::Cloud::CloudControlsPartner::V1::Workload::Partner]
54
+ # Partner associated with this workload.
55
+ class Workload
56
+ include ::Google::Protobuf::MessageExts
57
+ extend ::Google::Protobuf::MessageExts::ClassMethods
58
+
59
+ # Supported Assured Workloads Partners.
60
+ module Partner
61
+ # Unknown Partner.
62
+ PARTNER_UNSPECIFIED = 0
63
+
64
+ # Enum representing S3NS (Thales) partner.
65
+ PARTNER_LOCAL_CONTROLS_BY_S3NS = 1
66
+
67
+ # Enum representing T_SYSTEM (TSI) partner.
68
+ PARTNER_SOVEREIGN_CONTROLS_BY_T_SYSTEMS = 2
69
+
70
+ # Enum representing SIA_MINSAIT (Indra) partner.
71
+ PARTNER_SOVEREIGN_CONTROLS_BY_SIA_MINSAIT = 3
72
+
73
+ # Enum representing PSN (TIM) partner.
74
+ PARTNER_SOVEREIGN_CONTROLS_BY_PSN = 4
75
+
76
+ # Enum representing CNTXT (Kingdom of Saudi Arabia) partner.
77
+ PARTNER_SOVEREIGN_CONTROLS_BY_CNTXT = 6
78
+
79
+ # Enum representing CNXT (Kingdom of Saudi Arabia) partner offering without
80
+ # EKM provisioning.
81
+ PARTNER_SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM = 7
82
+ end
83
+ end
84
+
85
+ # Request to list customer workloads.
86
+ # @!attribute [rw] parent
87
+ # @return [::String]
88
+ # Required. Parent resource
89
+ # Format:
90
+ # `organizations/{organization}/locations/{location}/customers/{customer}`
91
+ # @!attribute [rw] page_size
92
+ # @return [::Integer]
93
+ # The maximum number of workloads to return. The service may return fewer
94
+ # than this value. If unspecified, at most 500 workloads will be returned.
95
+ # @!attribute [rw] page_token
96
+ # @return [::String]
97
+ # A page token, received from a previous `ListWorkloads` call.
98
+ # Provide this to retrieve the subsequent page.
99
+ # @!attribute [rw] filter
100
+ # @return [::String]
101
+ # Optional. Filtering results.
102
+ # @!attribute [rw] order_by
103
+ # @return [::String]
104
+ # Optional. Hint for how to order the results.
105
+ class ListWorkloadsRequest
106
+ include ::Google::Protobuf::MessageExts
107
+ extend ::Google::Protobuf::MessageExts::ClassMethods
108
+ end
109
+
110
+ # Response message for list customer workloads requests.
111
+ # @!attribute [rw] workloads
112
+ # @return [::Array<::Google::Cloud::CloudControlsPartner::V1::Workload>]
113
+ # List of customer workloads
114
+ # @!attribute [rw] next_page_token
115
+ # @return [::String]
116
+ # A token that can be sent as `page_token` to retrieve the next page.
117
+ # If this field is omitted, there are no subsequent pages.
118
+ # @!attribute [rw] unreachable
119
+ # @return [::Array<::String>]
120
+ # Locations that could not be reached.
121
+ class ListWorkloadsResponse
122
+ include ::Google::Protobuf::MessageExts
123
+ extend ::Google::Protobuf::MessageExts::ClassMethods
124
+ end
125
+
126
+ # Message for getting a customer workload.
127
+ # @!attribute [rw] name
128
+ # @return [::String]
129
+ # Required. Format:
130
+ # `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`
131
+ class GetWorkloadRequest
132
+ include ::Google::Protobuf::MessageExts
133
+ extend ::Google::Protobuf::MessageExts::ClassMethods
134
+ end
135
+
136
+ # Container for workload onboarding steps.
137
+ # @!attribute [rw] onboarding_steps
138
+ # @return [::Array<::Google::Cloud::CloudControlsPartner::V1::WorkloadOnboardingStep>]
139
+ # List of workload onboarding steps.
140
+ class WorkloadOnboardingState
141
+ include ::Google::Protobuf::MessageExts
142
+ extend ::Google::Protobuf::MessageExts::ClassMethods
143
+ end
144
+
145
+ # Container for workload onboarding information.
146
+ # @!attribute [rw] step
147
+ # @return [::Google::Cloud::CloudControlsPartner::V1::WorkloadOnboardingStep::Step]
148
+ # The onboarding step.
149
+ # @!attribute [rw] start_time
150
+ # @return [::Google::Protobuf::Timestamp]
151
+ # The starting time of the onboarding step.
152
+ # @!attribute [rw] completion_time
153
+ # @return [::Google::Protobuf::Timestamp]
154
+ # The completion time of the onboarding step.
155
+ # @!attribute [r] completion_state
156
+ # @return [::Google::Cloud::CloudControlsPartner::V1::CompletionState]
157
+ # Output only. The completion state of the onboarding step.
158
+ class WorkloadOnboardingStep
159
+ include ::Google::Protobuf::MessageExts
160
+ extend ::Google::Protobuf::MessageExts::ClassMethods
161
+
162
+ # Enum for possible onboarding steps.
163
+ module Step
164
+ # Unspecified step.
165
+ STEP_UNSPECIFIED = 0
166
+
167
+ # EKM Provisioned step.
168
+ EKM_PROVISIONED = 1
169
+
170
+ # Signed Access Approval step.
171
+ SIGNED_ACCESS_APPROVAL_CONFIGURED = 2
172
+ end
173
+ end
174
+ end
175
+ end
176
+ end
177
+ end