google-cloud-workload_identity-v1 0.a → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +154 -8
  5. data/lib/google/cloud/workload_identity/v1/bindings_override.rb +107 -0
  6. data/lib/google/cloud/workload_identity/v1/rest.rb +38 -0
  7. data/lib/google/cloud/workload_identity/v1/version.rb +7 -2
  8. data/lib/google/cloud/workload_identity/v1/workload_identity/client.rb +528 -0
  9. data/lib/google/cloud/workload_identity/v1/workload_identity/credentials.rb +47 -0
  10. data/lib/google/cloud/workload_identity/v1/workload_identity/operations.rb +843 -0
  11. data/lib/google/cloud/workload_identity/v1/workload_identity/paths.rb +91 -0
  12. data/lib/google/cloud/workload_identity/v1/workload_identity/rest/client.rb +486 -0
  13. data/lib/google/cloud/workload_identity/v1/workload_identity/rest/operations.rb +985 -0
  14. data/lib/google/cloud/workload_identity/v1/workload_identity/rest/service_stub.rb +159 -0
  15. data/lib/google/cloud/workload_identity/v1/workload_identity/rest.rb +54 -0
  16. data/lib/google/cloud/workload_identity/v1/workload_identity.rb +56 -0
  17. data/lib/google/cloud/workload_identity/v1.rb +45 -0
  18. data/lib/google/cloud/workloadidentity/v1/service_pb.rb +32 -0
  19. data/lib/google/cloud/workloadidentity/v1/service_services_pb.rb +46 -0
  20. data/lib/google-cloud-workload_identity-v1.rb +21 -0
  21. data/proto_docs/README.md +4 -0
  22. data/proto_docs/google/api/client.rb +593 -0
  23. data/proto_docs/google/api/field_behavior.rb +85 -0
  24. data/proto_docs/google/api/launch_stage.rb +71 -0
  25. data/proto_docs/google/api/resource.rb +227 -0
  26. data/proto_docs/google/cloud/workloadidentity/v1/service.rb +129 -0
  27. data/proto_docs/google/longrunning/operations.rb +191 -0
  28. data/proto_docs/google/protobuf/any.rb +145 -0
  29. data/proto_docs/google/protobuf/duration.rb +98 -0
  30. data/proto_docs/google/protobuf/empty.rb +34 -0
  31. data/proto_docs/google/protobuf/timestamp.rb +128 -0
  32. data/proto_docs/google/rpc/status.rb +48 -0
  33. metadata +79 -9
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 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
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,227 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 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'. One exception
128
+ # to this is for Nested Collections that have stuttering names, as defined
129
+ # in [AIP-122](https://google.aip.dev/122#nested-collections), where the
130
+ # collection ID in the resource name pattern does not necessarily directly
131
+ # match the `plural` value.
132
+ #
133
+ # It is the same concept of the `plural` field in k8s CRD spec
134
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
135
+ #
136
+ # Note: The plural form is required even for singleton resources. See
137
+ # https://aip.dev/156
138
+ # @!attribute [rw] singular
139
+ # @return [::String]
140
+ # The same concept of the `singular` field in k8s CRD spec
141
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
142
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
143
+ # @!attribute [rw] style
144
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
145
+ # Style flag(s) for this resource.
146
+ # These indicate that a resource is expected to conform to a given
147
+ # style. See the specific style flags for additional information.
148
+ class ResourceDescriptor
149
+ include ::Google::Protobuf::MessageExts
150
+ extend ::Google::Protobuf::MessageExts::ClassMethods
151
+
152
+ # A description of the historical or future-looking state of the
153
+ # resource pattern.
154
+ module History
155
+ # The "unset" value.
156
+ HISTORY_UNSPECIFIED = 0
157
+
158
+ # The resource originally had one pattern and launched as such, and
159
+ # additional patterns were added later.
160
+ ORIGINALLY_SINGLE_PATTERN = 1
161
+
162
+ # The resource has one pattern, but the API owner expects to add more
163
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
164
+ # that from being necessary once there are multiple patterns.)
165
+ FUTURE_MULTI_PATTERN = 2
166
+ end
167
+
168
+ # A flag representing a specific style that a resource claims to conform to.
169
+ module Style
170
+ # The unspecified value. Do not use.
171
+ STYLE_UNSPECIFIED = 0
172
+
173
+ # This resource is intended to be "declarative-friendly".
174
+ #
175
+ # Declarative-friendly resources must be more strictly consistent, and
176
+ # setting this to true communicates to tools that this resource should
177
+ # adhere to declarative-friendly expectations.
178
+ #
179
+ # Note: This is used by the API linter (linter.aip.dev) to enable
180
+ # additional checks.
181
+ DECLARATIVE_FRIENDLY = 1
182
+ end
183
+ end
184
+
185
+ # Defines a proto annotation that describes a string field that refers to
186
+ # an API resource.
187
+ # @!attribute [rw] type
188
+ # @return [::String]
189
+ # The resource type that the annotated field references.
190
+ #
191
+ # Example:
192
+ #
193
+ # message Subscription {
194
+ # string topic = 2 [(google.api.resource_reference) = {
195
+ # type: "pubsub.googleapis.com/Topic"
196
+ # }];
197
+ # }
198
+ #
199
+ # Occasionally, a field may reference an arbitrary resource. In this case,
200
+ # APIs use the special value * in their resource reference.
201
+ #
202
+ # Example:
203
+ #
204
+ # message GetIamPolicyRequest {
205
+ # string resource = 2 [(google.api.resource_reference) = {
206
+ # type: "*"
207
+ # }];
208
+ # }
209
+ # @!attribute [rw] child_type
210
+ # @return [::String]
211
+ # The resource type of a child collection that the annotated field
212
+ # references. This is useful for annotating the `parent` field that
213
+ # doesn't have a fixed resource type.
214
+ #
215
+ # Example:
216
+ #
217
+ # message ListLogEntriesRequest {
218
+ # string parent = 1 [(google.api.resource_reference) = {
219
+ # child_type: "logging.googleapis.com/LogEntry"
220
+ # };
221
+ # }
222
+ class ResourceReference
223
+ include ::Google::Protobuf::MessageExts
224
+ extend ::Google::Protobuf::MessageExts::ClassMethods
225
+ end
226
+ end
227
+ end
@@ -0,0 +1,129 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 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 WorkloadIdentity
23
+ module V1
24
+ # Message describing ServiceAgent object
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Identifier. The name of the service agent resource
28
+ # @!attribute [rw] container
29
+ # @return [::String]
30
+ # Optional. Name of the container that the service agent is associated with.
31
+ # For example:
32
+ # * projects/1234
33
+ # * folders/1234
34
+ # * organizations/2344
35
+ # @!attribute [rw] service_producer
36
+ # @return [::String]
37
+ # Optional. The service the agent belongs to.
38
+ # For example, bigquery.googleapis.com
39
+ # @!attribute [rw] principal
40
+ # @return [::String]
41
+ # Optional. The principal identifier for the service agent. This identifier
42
+ # is used in allow policies to grant access to the service agent.
43
+ # @!attribute [rw] role
44
+ # @return [::String]
45
+ # Optional. The role that should be granted to service agent on consumer
46
+ # project, if any. For example, "roles/aiplatform.serviceAgent".
47
+ # @!attribute [r] state
48
+ # @return [::Google::Cloud::WorkloadIdentity::V1::ServiceAgent::State]
49
+ # Output only. Service agent state.
50
+ class ServiceAgent
51
+ include ::Google::Protobuf::MessageExts
52
+ extend ::Google::Protobuf::MessageExts::ClassMethods
53
+
54
+ # Enum for service agent `state`.
55
+ module State
56
+ # Default service agent `state`. This value is used if the
57
+ # state is omitted.
58
+ STATE_UNSPECIFIED = 0
59
+
60
+ # Indicates that the service agent has been created and can be used.
61
+ ACTIVE = 1
62
+
63
+ # Indicates that the service agent was not created.
64
+ FAILED = 2
65
+ end
66
+ end
67
+
68
+ # Message for creating all ServiceAgents for a ServiceProducer in a project and
69
+ # location.
70
+ # @!attribute [rw] parent
71
+ # @return [::String]
72
+ # Required. The parent resource. The `location` for the parent resource must
73
+ # be `global`.
74
+ #
75
+ # Examples:
76
+ #
77
+ # - projects/1234/locations/global/serviceProducers/bigquery.googleapis.com
78
+ # - folders/2344/locations/global/serviceProducers/vertexai.googleapis.com
79
+ # - organizations/3344/locations/global/serviceProducers/iam.googleapis.com
80
+ class GenerateServiceAgentsRequest
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # Message for creating all ServiceAgents for a ServiceProducer in a project and
86
+ # location.
87
+ # @!attribute [rw] service_agents
88
+ # @return [::Array<::Google::Cloud::WorkloadIdentity::V1::ServiceAgent>]
89
+ # The list of service agents
90
+ class GenerateServiceAgentsResponse
91
+ include ::Google::Protobuf::MessageExts
92
+ extend ::Google::Protobuf::MessageExts::ClassMethods
93
+ end
94
+
95
+ # Represents the metadata of the long-running operation.
96
+ # @!attribute [r] create_time
97
+ # @return [::Google::Protobuf::Timestamp]
98
+ # Output only. The time the operation was created.
99
+ # @!attribute [r] end_time
100
+ # @return [::Google::Protobuf::Timestamp]
101
+ # Output only. The time the operation finished running.
102
+ # @!attribute [r] target
103
+ # @return [::String]
104
+ # Output only. Server-defined resource path for the target of the operation.
105
+ # @!attribute [r] verb
106
+ # @return [::String]
107
+ # Output only. Name of the verb executed by the operation.
108
+ # @!attribute [r] status_message
109
+ # @return [::String]
110
+ # Output only. Human-readable status of the operation, if any.
111
+ # @!attribute [r] requested_cancellation
112
+ # @return [::Boolean]
113
+ # Output only. Identifies whether the user has requested cancellation
114
+ # of the operation. Operations that have been cancelled successfully
115
+ # have
116
+ # {::Google::Longrunning::Operation#error google.longrunning.Operation.error}
117
+ # value with a {::Google::Rpc::Status#code google.rpc.Status.code} of `1`,
118
+ # corresponding to `Code.CANCELLED`.
119
+ # @!attribute [r] api_version
120
+ # @return [::String]
121
+ # Output only. API version used to start the operation.
122
+ class OperationMetadata
123
+ include ::Google::Protobuf::MessageExts
124
+ extend ::Google::Protobuf::MessageExts::ClassMethods
125
+ end
126
+ end
127
+ end
128
+ end
129
+ end
@@ -0,0 +1,191 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 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 Longrunning
22
+ # This resource represents a long-running operation that is the result of a
23
+ # network API call.
24
+ # @!attribute [rw] name
25
+ # @return [::String]
26
+ # The server-assigned name, which is only unique within the same service that
27
+ # originally returns it. If you use the default HTTP mapping, the
28
+ # `name` should be a resource name ending with `operations/{unique_id}`.
29
+ # @!attribute [rw] metadata
30
+ # @return [::Google::Protobuf::Any]
31
+ # Service-specific metadata associated with the operation. It typically
32
+ # contains progress information and common metadata such as create time.
33
+ # Some services might not provide such metadata. Any method that returns a
34
+ # long-running operation should document the metadata type, if any.
35
+ # @!attribute [rw] done
36
+ # @return [::Boolean]
37
+ # If the value is `false`, it means the operation is still in progress.
38
+ # If `true`, the operation is completed, and either `error` or `response` is
39
+ # available.
40
+ # @!attribute [rw] error
41
+ # @return [::Google::Rpc::Status]
42
+ # The error result of the operation in case of failure or cancellation.
43
+ #
44
+ # Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
45
+ # @!attribute [rw] response
46
+ # @return [::Google::Protobuf::Any]
47
+ # The normal, successful response of the operation. If the original
48
+ # method returns no data on success, such as `Delete`, the response is
49
+ # `google.protobuf.Empty`. If the original method is standard
50
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
51
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
52
+ # is the original method name. For example, if the original method name
53
+ # is `TakeSnapshot()`, the inferred response type is
54
+ # `TakeSnapshotResponse`.
55
+ #
56
+ # Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
57
+ class Operation
58
+ include ::Google::Protobuf::MessageExts
59
+ extend ::Google::Protobuf::MessageExts::ClassMethods
60
+ end
61
+
62
+ # The request message for
63
+ # Operations.GetOperation.
64
+ # @!attribute [rw] name
65
+ # @return [::String]
66
+ # The name of the operation resource.
67
+ class GetOperationRequest
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
+ end
71
+
72
+ # The request message for
73
+ # Operations.ListOperations.
74
+ # @!attribute [rw] name
75
+ # @return [::String]
76
+ # The name of the operation's parent resource.
77
+ # @!attribute [rw] filter
78
+ # @return [::String]
79
+ # The standard list filter.
80
+ # @!attribute [rw] page_size
81
+ # @return [::Integer]
82
+ # The standard list page size.
83
+ # @!attribute [rw] page_token
84
+ # @return [::String]
85
+ # The standard list page token.
86
+ # @!attribute [rw] return_partial_success
87
+ # @return [::Boolean]
88
+ # When set to `true`, operations that are reachable are returned as normal,
89
+ # and those that are unreachable are returned in the
90
+ # [ListOperationsResponse.unreachable] field.
91
+ #
92
+ # This can only be `true` when reading across collections e.g. when `parent`
93
+ # is set to `"projects/example/locations/-"`.
94
+ #
95
+ # This field is not by default supported and will result in an
96
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
97
+ # service or product specific documentation.
98
+ class ListOperationsRequest
99
+ include ::Google::Protobuf::MessageExts
100
+ extend ::Google::Protobuf::MessageExts::ClassMethods
101
+ end
102
+
103
+ # The response message for
104
+ # Operations.ListOperations.
105
+ # @!attribute [rw] operations
106
+ # @return [::Array<::Google::Longrunning::Operation>]
107
+ # A list of operations that matches the specified filter in the request.
108
+ # @!attribute [rw] next_page_token
109
+ # @return [::String]
110
+ # The standard List next-page token.
111
+ # @!attribute [rw] unreachable
112
+ # @return [::Array<::String>]
113
+ # Unordered list. Unreachable resources. Populated when the request sets
114
+ # `ListOperationsRequest.return_partial_success` and reads across
115
+ # collections e.g. when attempting to list all resources across all supported
116
+ # locations.
117
+ class ListOperationsResponse
118
+ include ::Google::Protobuf::MessageExts
119
+ extend ::Google::Protobuf::MessageExts::ClassMethods
120
+ end
121
+
122
+ # The request message for
123
+ # Operations.CancelOperation.
124
+ # @!attribute [rw] name
125
+ # @return [::String]
126
+ # The name of the operation resource to be cancelled.
127
+ class CancelOperationRequest
128
+ include ::Google::Protobuf::MessageExts
129
+ extend ::Google::Protobuf::MessageExts::ClassMethods
130
+ end
131
+
132
+ # The request message for
133
+ # Operations.DeleteOperation.
134
+ # @!attribute [rw] name
135
+ # @return [::String]
136
+ # The name of the operation resource to be deleted.
137
+ class DeleteOperationRequest
138
+ include ::Google::Protobuf::MessageExts
139
+ extend ::Google::Protobuf::MessageExts::ClassMethods
140
+ end
141
+
142
+ # The request message for
143
+ # Operations.WaitOperation.
144
+ # @!attribute [rw] name
145
+ # @return [::String]
146
+ # The name of the operation resource to wait on.
147
+ # @!attribute [rw] timeout
148
+ # @return [::Google::Protobuf::Duration]
149
+ # The maximum duration to wait before timing out. If left blank, the wait
150
+ # will be at most the time permitted by the underlying HTTP/RPC protocol.
151
+ # If RPC context deadline is also specified, the shorter one will be used.
152
+ class WaitOperationRequest
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+ end
156
+
157
+ # A message representing the message types used by a long-running operation.
158
+ #
159
+ # Example:
160
+ #
161
+ # rpc Export(ExportRequest) returns (google.longrunning.Operation) {
162
+ # option (google.longrunning.operation_info) = {
163
+ # response_type: "ExportResponse"
164
+ # metadata_type: "ExportMetadata"
165
+ # };
166
+ # }
167
+ # @!attribute [rw] response_type
168
+ # @return [::String]
169
+ # Required. The message name of the primary return type for this
170
+ # long-running operation.
171
+ # This type will be used to deserialize the LRO's response.
172
+ #
173
+ # If the response is in a different package from the rpc, a fully-qualified
174
+ # message name must be used (e.g. `google.protobuf.Struct`).
175
+ #
176
+ # Note: Altering this value constitutes a breaking change.
177
+ # @!attribute [rw] metadata_type
178
+ # @return [::String]
179
+ # Required. The message name of the metadata type for this long-running
180
+ # operation.
181
+ #
182
+ # If the response is in a different package from the rpc, a fully-qualified
183
+ # message name must be used (e.g. `google.protobuf.Struct`).
184
+ #
185
+ # Note: Altering this value constitutes a breaking change.
186
+ class OperationInfo
187
+ include ::Google::Protobuf::MessageExts
188
+ extend ::Google::Protobuf::MessageExts::ClassMethods
189
+ end
190
+ end
191
+ end