google-cloud-artifact_registry-v1 0.2.2 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb +2488 -91
  4. data/lib/google/cloud/artifact_registry/v1/artifact_registry/operations.rb +767 -0
  5. data/lib/google/cloud/artifact_registry/v1/artifact_registry/paths.rb +58 -0
  6. data/lib/google/cloud/artifact_registry/v1/artifact_registry.rb +1 -0
  7. data/lib/google/cloud/artifact_registry/v1/version.rb +1 -1
  8. data/lib/google/cloud/artifact_registry/v1.rb +2 -0
  9. data/lib/google/devtools/artifactregistry/v1/apt_artifact_pb.rb +63 -0
  10. data/lib/google/devtools/artifactregistry/v1/artifact_pb.rb +4 -1
  11. data/lib/google/devtools/artifactregistry/v1/file_pb.rb +57 -0
  12. data/lib/google/devtools/artifactregistry/v1/package_pb.rb +47 -0
  13. data/lib/google/devtools/artifactregistry/v1/repository_pb.rb +30 -1
  14. data/lib/google/devtools/artifactregistry/v1/service_pb.rb +13 -0
  15. data/lib/google/devtools/artifactregistry/v1/service_services_pb.rb +59 -0
  16. data/lib/google/devtools/artifactregistry/v1/settings_pb.rb +42 -0
  17. data/lib/google/devtools/artifactregistry/v1/tag_pb.rb +56 -0
  18. data/lib/google/devtools/artifactregistry/v1/version_pb.rb +61 -0
  19. data/lib/google/devtools/artifactregistry/v1/yum_artifact_pb.rb +61 -0
  20. data/proto_docs/google/devtools/artifactregistry/v1/apt_artifact.rb +118 -0
  21. data/proto_docs/google/devtools/artifactregistry/v1/artifact.rb +9 -0
  22. data/proto_docs/google/devtools/artifactregistry/v1/file.rb +131 -0
  23. data/proto_docs/google/devtools/artifactregistry/v1/package.rb +93 -0
  24. data/proto_docs/google/devtools/artifactregistry/v1/repository.rb +73 -2
  25. data/proto_docs/google/devtools/artifactregistry/v1/service.rb +32 -0
  26. data/proto_docs/google/devtools/artifactregistry/v1/settings.rb +80 -0
  27. data/proto_docs/google/devtools/artifactregistry/v1/tag.rb +132 -0
  28. data/proto_docs/google/devtools/artifactregistry/v1/version.rb +132 -0
  29. data/proto_docs/google/devtools/artifactregistry/v1/yum_artifact.rb +110 -0
  30. data/proto_docs/google/iam/v1/iam_policy.rb +80 -0
  31. data/proto_docs/google/iam/v1/options.rb +40 -0
  32. data/proto_docs/google/longrunning/operations.rb +164 -0
  33. data/proto_docs/google/protobuf/any.rb +141 -0
  34. data/proto_docs/google/protobuf/duration.rb +98 -0
  35. data/proto_docs/google/protobuf/empty.rb +36 -0
  36. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  37. data/proto_docs/google/protobuf/struct.rb +96 -0
  38. data/proto_docs/google/rpc/status.rb +46 -0
  39. metadata +28 -3
@@ -0,0 +1,132 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 ArtifactRegistry
23
+ module V1
24
+ # Tags point to a version and represent an alternative name that can be used
25
+ # to access the version.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # The name of the tag, for example:
29
+ # "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1".
30
+ # If the package part contains slashes, the slashes are escaped.
31
+ # The tag part can only have characters in [a-zA-Z0-9\-._~:@], anything else
32
+ # must be URL encoded.
33
+ # @!attribute [rw] version
34
+ # @return [::String]
35
+ # The name of the version the tag refers to, for example:
36
+ # "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811"
37
+ # If the package or version ID parts contain slashes, the slashes are
38
+ # escaped.
39
+ class Tag
40
+ include ::Google::Protobuf::MessageExts
41
+ extend ::Google::Protobuf::MessageExts::ClassMethods
42
+ end
43
+
44
+ # The request to list tags.
45
+ # @!attribute [rw] parent
46
+ # @return [::String]
47
+ # The name of the parent resource whose tags will be listed.
48
+ # @!attribute [rw] filter
49
+ # @return [::String]
50
+ # An expression for filtering the results of the request. Filter rules are
51
+ # case insensitive. The fields eligible for filtering are:
52
+ #
53
+ # * `version`
54
+ #
55
+ # An example of using a filter:
56
+ #
57
+ # * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"`
58
+ # --> Tags that are applied to the version `1.0` in package `pkg1`.
59
+ # @!attribute [rw] page_size
60
+ # @return [::Integer]
61
+ # The maximum number of tags to return. Maximum page size is 10,000.
62
+ # @!attribute [rw] page_token
63
+ # @return [::String]
64
+ # The next_page_token value returned from a previous list request, if any.
65
+ class ListTagsRequest
66
+ include ::Google::Protobuf::MessageExts
67
+ extend ::Google::Protobuf::MessageExts::ClassMethods
68
+ end
69
+
70
+ # The response from listing tags.
71
+ # @!attribute [rw] tags
72
+ # @return [::Array<::Google::Cloud::ArtifactRegistry::V1::Tag>]
73
+ # The tags returned.
74
+ # @!attribute [rw] next_page_token
75
+ # @return [::String]
76
+ # The token to retrieve the next page of tags, or empty if there are no
77
+ # more tags to return.
78
+ class ListTagsResponse
79
+ include ::Google::Protobuf::MessageExts
80
+ extend ::Google::Protobuf::MessageExts::ClassMethods
81
+ end
82
+
83
+ # The request to retrieve a tag.
84
+ # @!attribute [rw] name
85
+ # @return [::String]
86
+ # The name of the tag to retrieve.
87
+ class GetTagRequest
88
+ include ::Google::Protobuf::MessageExts
89
+ extend ::Google::Protobuf::MessageExts::ClassMethods
90
+ end
91
+
92
+ # The request to create a new tag.
93
+ # @!attribute [rw] parent
94
+ # @return [::String]
95
+ # The name of the parent resource where the tag will be created.
96
+ # @!attribute [rw] tag_id
97
+ # @return [::String]
98
+ # The tag id to use for this repository.
99
+ # @!attribute [rw] tag
100
+ # @return [::Google::Cloud::ArtifactRegistry::V1::Tag]
101
+ # The tag to be created.
102
+ class CreateTagRequest
103
+ include ::Google::Protobuf::MessageExts
104
+ extend ::Google::Protobuf::MessageExts::ClassMethods
105
+ end
106
+
107
+ # The request to create or update a tag.
108
+ # @!attribute [rw] tag
109
+ # @return [::Google::Cloud::ArtifactRegistry::V1::Tag]
110
+ # The tag that replaces the resource on the server.
111
+ # @!attribute [rw] update_mask
112
+ # @return [::Google::Protobuf::FieldMask]
113
+ # The update mask applies to the resource. For the `FieldMask` definition,
114
+ # see
115
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
116
+ class UpdateTagRequest
117
+ include ::Google::Protobuf::MessageExts
118
+ extend ::Google::Protobuf::MessageExts::ClassMethods
119
+ end
120
+
121
+ # The request to delete a tag.
122
+ # @!attribute [rw] name
123
+ # @return [::String]
124
+ # The name of the tag to delete.
125
+ class DeleteTagRequest
126
+ include ::Google::Protobuf::MessageExts
127
+ extend ::Google::Protobuf::MessageExts::ClassMethods
128
+ end
129
+ end
130
+ end
131
+ end
132
+ end
@@ -0,0 +1,132 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 ArtifactRegistry
23
+ module V1
24
+ # The body of a version resource. A version resource represents a
25
+ # collection of components, such as files and other data. This may correspond
26
+ # to a version in many package management schemes.
27
+ # @!attribute [rw] name
28
+ # @return [::String]
29
+ # The name of the version, for example:
30
+ # "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1".
31
+ # If the package or version ID parts contain slashes, the slashes are
32
+ # escaped.
33
+ # @!attribute [rw] description
34
+ # @return [::String]
35
+ # Optional. Description of the version, as specified in its metadata.
36
+ # @!attribute [rw] create_time
37
+ # @return [::Google::Protobuf::Timestamp]
38
+ # The time when the version was created.
39
+ # @!attribute [rw] update_time
40
+ # @return [::Google::Protobuf::Timestamp]
41
+ # The time when the version was last updated.
42
+ # @!attribute [rw] related_tags
43
+ # @return [::Array<::Google::Cloud::ArtifactRegistry::V1::Tag>]
44
+ # Output only. A list of related tags. Will contain up to 100 tags that
45
+ # reference this version.
46
+ # @!attribute [r] metadata
47
+ # @return [::Google::Protobuf::Struct]
48
+ # Output only. Repository-specific Metadata stored against this version.
49
+ # The fields returned are defined by the underlying repository-specific
50
+ # resource. Currently, the only resource in use is
51
+ # {::Google::Cloud::ArtifactRegistry::V1::DockerImage DockerImage}
52
+ class Version
53
+ include ::Google::Protobuf::MessageExts
54
+ extend ::Google::Protobuf::MessageExts::ClassMethods
55
+ end
56
+
57
+ # The request to list versions.
58
+ # @!attribute [rw] parent
59
+ # @return [::String]
60
+ # The name of the parent resource whose versions will be listed.
61
+ # @!attribute [rw] page_size
62
+ # @return [::Integer]
63
+ # The maximum number of versions to return. Maximum page size is 1,000.
64
+ # @!attribute [rw] page_token
65
+ # @return [::String]
66
+ # The next_page_token value returned from a previous list request, if any.
67
+ # @!attribute [rw] view
68
+ # @return [::Google::Cloud::ArtifactRegistry::V1::VersionView]
69
+ # The view that should be returned in the response.
70
+ # @!attribute [rw] order_by
71
+ # @return [::String]
72
+ # Optional. The field to order the results by.
73
+ class ListVersionsRequest
74
+ include ::Google::Protobuf::MessageExts
75
+ extend ::Google::Protobuf::MessageExts::ClassMethods
76
+ end
77
+
78
+ # The response from listing versions.
79
+ # @!attribute [rw] versions
80
+ # @return [::Array<::Google::Cloud::ArtifactRegistry::V1::Version>]
81
+ # The versions returned.
82
+ # @!attribute [rw] next_page_token
83
+ # @return [::String]
84
+ # The token to retrieve the next page of versions, or empty if there are no
85
+ # more versions to return.
86
+ class ListVersionsResponse
87
+ include ::Google::Protobuf::MessageExts
88
+ extend ::Google::Protobuf::MessageExts::ClassMethods
89
+ end
90
+
91
+ # The request to retrieve a version.
92
+ # @!attribute [rw] name
93
+ # @return [::String]
94
+ # The name of the version to retrieve.
95
+ # @!attribute [rw] view
96
+ # @return [::Google::Cloud::ArtifactRegistry::V1::VersionView]
97
+ # The view that should be returned in the response.
98
+ class GetVersionRequest
99
+ include ::Google::Protobuf::MessageExts
100
+ extend ::Google::Protobuf::MessageExts::ClassMethods
101
+ end
102
+
103
+ # The request to delete a version.
104
+ # @!attribute [rw] name
105
+ # @return [::String]
106
+ # The name of the version to delete.
107
+ # @!attribute [rw] force
108
+ # @return [::Boolean]
109
+ # By default, a version that is tagged may not be deleted. If force=true, the
110
+ # version and any tags pointing to the version are deleted.
111
+ class DeleteVersionRequest
112
+ include ::Google::Protobuf::MessageExts
113
+ extend ::Google::Protobuf::MessageExts::ClassMethods
114
+ end
115
+
116
+ # The view, which determines what version information is returned in a
117
+ # response.
118
+ module VersionView
119
+ # The default / unset value.
120
+ # The API will default to the BASIC view.
121
+ VERSION_VIEW_UNSPECIFIED = 0
122
+
123
+ # Includes basic information about the version, but not any related tags.
124
+ BASIC = 1
125
+
126
+ # Include everything.
127
+ FULL = 2
128
+ end
129
+ end
130
+ end
131
+ end
132
+ end
@@ -0,0 +1,110 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 ArtifactRegistry
23
+ module V1
24
+ # A detailed representation of a Yum artifact.
25
+ # @!attribute [r] name
26
+ # @return [::String]
27
+ # Output only. The Artifact Registry resource name of the artifact.
28
+ # @!attribute [r] package_name
29
+ # @return [::String]
30
+ # Output only. The yum package name of the artifact.
31
+ # @!attribute [r] package_type
32
+ # @return [::Google::Cloud::ArtifactRegistry::V1::YumArtifact::PackageType]
33
+ # Output only. An artifact is a binary or source package.
34
+ # @!attribute [r] architecture
35
+ # @return [::String]
36
+ # Output only. Operating system architecture of the artifact.
37
+ class YumArtifact
38
+ include ::Google::Protobuf::MessageExts
39
+ extend ::Google::Protobuf::MessageExts::ClassMethods
40
+
41
+ # Package type is either binary or source.
42
+ module PackageType
43
+ # Package type is not specified.
44
+ PACKAGE_TYPE_UNSPECIFIED = 0
45
+
46
+ # Binary package (.rpm).
47
+ BINARY = 1
48
+
49
+ # Source package (.srpm).
50
+ SOURCE = 2
51
+ end
52
+ end
53
+
54
+ # Google Cloud Storage location where the artifacts currently reside.
55
+ # @!attribute [rw] uris
56
+ # @return [::Array<::String>]
57
+ # Cloud Storage paths URI (e.g., gs://my_bucket//my_object).
58
+ # @!attribute [rw] use_wildcards
59
+ # @return [::Boolean]
60
+ # Supports URI wildcards for matching multiple objects from a single URI.
61
+ class ImportYumArtifactsGcsSource
62
+ include ::Google::Protobuf::MessageExts
63
+ extend ::Google::Protobuf::MessageExts::ClassMethods
64
+ end
65
+
66
+ # The request to import new yum artifacts.
67
+ # @!attribute [rw] gcs_source
68
+ # @return [::Google::Cloud::ArtifactRegistry::V1::ImportYumArtifactsGcsSource]
69
+ # Google Cloud Storage location where input content is located.
70
+ # @!attribute [rw] parent
71
+ # @return [::String]
72
+ # The name of the parent resource where the artifacts will be imported.
73
+ class ImportYumArtifactsRequest
74
+ include ::Google::Protobuf::MessageExts
75
+ extend ::Google::Protobuf::MessageExts::ClassMethods
76
+ end
77
+
78
+ # Error information explaining why a package was not imported.
79
+ # @!attribute [rw] gcs_source
80
+ # @return [::Google::Cloud::ArtifactRegistry::V1::ImportYumArtifactsGcsSource]
81
+ # Google Cloud Storage location requested.
82
+ # @!attribute [rw] error
83
+ # @return [::Google::Rpc::Status]
84
+ # The detailed error status.
85
+ class ImportYumArtifactsErrorInfo
86
+ include ::Google::Protobuf::MessageExts
87
+ extend ::Google::Protobuf::MessageExts::ClassMethods
88
+ end
89
+
90
+ # The response message from importing YUM artifacts.
91
+ # @!attribute [rw] yum_artifacts
92
+ # @return [::Array<::Google::Cloud::ArtifactRegistry::V1::YumArtifact>]
93
+ # The yum artifacts imported.
94
+ # @!attribute [rw] errors
95
+ # @return [::Array<::Google::Cloud::ArtifactRegistry::V1::ImportYumArtifactsErrorInfo>]
96
+ # Detailed error info for packages that were not imported.
97
+ class ImportYumArtifactsResponse
98
+ include ::Google::Protobuf::MessageExts
99
+ extend ::Google::Protobuf::MessageExts::ClassMethods
100
+ end
101
+
102
+ # The operation metadata for importing artifacts.
103
+ class ImportYumArtifactsMetadata
104
+ include ::Google::Protobuf::MessageExts
105
+ extend ::Google::Protobuf::MessageExts::ClassMethods
106
+ end
107
+ end
108
+ end
109
+ end
110
+ end
@@ -0,0 +1,80 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 Iam
22
+ module V1
23
+ # Request message for `SetIamPolicy` method.
24
+ # @!attribute [rw] resource
25
+ # @return [::String]
26
+ # REQUIRED: The resource for which the policy is being specified.
27
+ # See the operation documentation for the appropriate value for this field.
28
+ # @!attribute [rw] policy
29
+ # @return [::Google::Iam::V1::Policy]
30
+ # REQUIRED: The complete policy to be applied to the `resource`. The size of
31
+ # the policy is limited to a few 10s of KB. An empty policy is a
32
+ # valid policy but certain Cloud Platform services (such as Projects)
33
+ # might reject them.
34
+ class SetIamPolicyRequest
35
+ include ::Google::Protobuf::MessageExts
36
+ extend ::Google::Protobuf::MessageExts::ClassMethods
37
+ end
38
+
39
+ # Request message for `GetIamPolicy` method.
40
+ # @!attribute [rw] resource
41
+ # @return [::String]
42
+ # REQUIRED: The resource for which the policy is being requested.
43
+ # See the operation documentation for the appropriate value for this field.
44
+ # @!attribute [rw] options
45
+ # @return [::Google::Iam::V1::GetPolicyOptions]
46
+ # OPTIONAL: A `GetPolicyOptions` object for specifying options to
47
+ # `GetIamPolicy`. This field is only used by Cloud IAM.
48
+ class GetIamPolicyRequest
49
+ include ::Google::Protobuf::MessageExts
50
+ extend ::Google::Protobuf::MessageExts::ClassMethods
51
+ end
52
+
53
+ # Request message for `TestIamPermissions` method.
54
+ # @!attribute [rw] resource
55
+ # @return [::String]
56
+ # REQUIRED: The resource for which the policy detail is being requested.
57
+ # See the operation documentation for the appropriate value for this field.
58
+ # @!attribute [rw] permissions
59
+ # @return [::Array<::String>]
60
+ # The set of permissions to check for the `resource`. Permissions with
61
+ # wildcards (such as '*' or 'storage.*') are not allowed. For more
62
+ # information see
63
+ # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
64
+ class TestIamPermissionsRequest
65
+ include ::Google::Protobuf::MessageExts
66
+ extend ::Google::Protobuf::MessageExts::ClassMethods
67
+ end
68
+
69
+ # Response message for `TestIamPermissions` method.
70
+ # @!attribute [rw] permissions
71
+ # @return [::Array<::String>]
72
+ # A subset of `TestPermissionsRequest.permissions` that the caller is
73
+ # allowed.
74
+ class TestIamPermissionsResponse
75
+ include ::Google::Protobuf::MessageExts
76
+ extend ::Google::Protobuf::MessageExts::ClassMethods
77
+ end
78
+ end
79
+ end
80
+ end
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 Iam
22
+ module V1
23
+ # Encapsulates settings provided to GetIamPolicy.
24
+ # @!attribute [rw] requested_policy_version
25
+ # @return [::Integer]
26
+ # Optional. The policy format version to be returned.
27
+ #
28
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
29
+ # rejected.
30
+ #
31
+ # Requests for policies with any conditional bindings must specify version 3.
32
+ # Policies without any conditional bindings may specify any valid value or
33
+ # leave the field unset.
34
+ class GetPolicyOptions
35
+ include ::Google::Protobuf::MessageExts
36
+ extend ::Google::Protobuf::MessageExts::ClassMethods
37
+ end
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,164 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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
+ # @!attribute [rw] response
44
+ # @return [::Google::Protobuf::Any]
45
+ # The normal response of the operation in case of success. If the original
46
+ # method returns no data on success, such as `Delete`, the response is
47
+ # `google.protobuf.Empty`. If the original method is standard
48
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
49
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
50
+ # is the original method name. For example, if the original method name
51
+ # is `TakeSnapshot()`, the inferred response type is
52
+ # `TakeSnapshotResponse`.
53
+ class Operation
54
+ include ::Google::Protobuf::MessageExts
55
+ extend ::Google::Protobuf::MessageExts::ClassMethods
56
+ end
57
+
58
+ # The request message for Operations.GetOperation.
59
+ # @!attribute [rw] name
60
+ # @return [::String]
61
+ # The name of the operation resource.
62
+ class GetOperationRequest
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+ end
66
+
67
+ # The request message for Operations.ListOperations.
68
+ # @!attribute [rw] name
69
+ # @return [::String]
70
+ # The name of the operation's parent resource.
71
+ # @!attribute [rw] filter
72
+ # @return [::String]
73
+ # The standard list filter.
74
+ # @!attribute [rw] page_size
75
+ # @return [::Integer]
76
+ # The standard list page size.
77
+ # @!attribute [rw] page_token
78
+ # @return [::String]
79
+ # The standard list page token.
80
+ class ListOperationsRequest
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # The response message for Operations.ListOperations.
86
+ # @!attribute [rw] operations
87
+ # @return [::Array<::Google::Longrunning::Operation>]
88
+ # A list of operations that matches the specified filter in the request.
89
+ # @!attribute [rw] next_page_token
90
+ # @return [::String]
91
+ # The standard List next-page token.
92
+ class ListOperationsResponse
93
+ include ::Google::Protobuf::MessageExts
94
+ extend ::Google::Protobuf::MessageExts::ClassMethods
95
+ end
96
+
97
+ # The request message for Operations.CancelOperation.
98
+ # @!attribute [rw] name
99
+ # @return [::String]
100
+ # The name of the operation resource to be cancelled.
101
+ class CancelOperationRequest
102
+ include ::Google::Protobuf::MessageExts
103
+ extend ::Google::Protobuf::MessageExts::ClassMethods
104
+ end
105
+
106
+ # The request message for Operations.DeleteOperation.
107
+ # @!attribute [rw] name
108
+ # @return [::String]
109
+ # The name of the operation resource to be deleted.
110
+ class DeleteOperationRequest
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
+ end
114
+
115
+ # The request message for Operations.WaitOperation.
116
+ # @!attribute [rw] name
117
+ # @return [::String]
118
+ # The name of the operation resource to wait on.
119
+ # @!attribute [rw] timeout
120
+ # @return [::Google::Protobuf::Duration]
121
+ # The maximum duration to wait before timing out. If left blank, the wait
122
+ # will be at most the time permitted by the underlying HTTP/RPC protocol.
123
+ # If RPC context deadline is also specified, the shorter one will be used.
124
+ class WaitOperationRequest
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+ end
128
+
129
+ # A message representing the message types used by a long-running operation.
130
+ #
131
+ # Example:
132
+ #
133
+ # rpc LongRunningRecognize(LongRunningRecognizeRequest)
134
+ # returns (google.longrunning.Operation) {
135
+ # option (google.longrunning.operation_info) = {
136
+ # response_type: "LongRunningRecognizeResponse"
137
+ # metadata_type: "LongRunningRecognizeMetadata"
138
+ # };
139
+ # }
140
+ # @!attribute [rw] response_type
141
+ # @return [::String]
142
+ # Required. The message name of the primary return type for this
143
+ # long-running operation.
144
+ # This type will be used to deserialize the LRO's response.
145
+ #
146
+ # If the response is in a different package from the rpc, a fully-qualified
147
+ # message name must be used (e.g. `google.protobuf.Struct`).
148
+ #
149
+ # Note: Altering this value constitutes a breaking change.
150
+ # @!attribute [rw] metadata_type
151
+ # @return [::String]
152
+ # Required. The message name of the metadata type for this long-running
153
+ # operation.
154
+ #
155
+ # If the response is in a different package from the rpc, a fully-qualified
156
+ # message name must be used (e.g. `google.protobuf.Struct`).
157
+ #
158
+ # Note: Altering this value constitutes a breaking change.
159
+ class OperationInfo
160
+ include ::Google::Protobuf::MessageExts
161
+ extend ::Google::Protobuf::MessageExts::ClassMethods
162
+ end
163
+ end
164
+ end