google-cloud-app_optimize-v1beta 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.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +154 -8
- data/lib/google/cloud/app_optimize/v1beta/version.rb +7 -2
- data/lib/google/cloud/appoptimize/v1beta/app_optimize/client.rb +959 -0
- data/lib/google/cloud/appoptimize/v1beta/app_optimize/credentials.rb +47 -0
- data/lib/google/cloud/appoptimize/v1beta/app_optimize/operations.rb +841 -0
- data/lib/google/cloud/appoptimize/v1beta/app_optimize/paths.rb +102 -0
- data/lib/google/cloud/appoptimize/v1beta/app_optimize/rest/client.rb +889 -0
- data/lib/google/cloud/appoptimize/v1beta/app_optimize/rest/operations.rb +925 -0
- data/lib/google/cloud/appoptimize/v1beta/app_optimize/rest/service_stub.rb +388 -0
- data/lib/google/cloud/appoptimize/v1beta/app_optimize/rest.rb +54 -0
- data/lib/google/cloud/appoptimize/v1beta/app_optimize.rb +56 -0
- data/lib/google/cloud/appoptimize/v1beta/app_optimize_pb.rb +40 -0
- data/lib/google/cloud/appoptimize/v1beta/app_optimize_services_pb.rb +57 -0
- data/lib/google/cloud/appoptimize/v1beta/bindings_override.rb +75 -0
- data/lib/google/cloud/appoptimize/v1beta/rest.rb +38 -0
- data/lib/google/cloud/appoptimize/v1beta.rb +45 -0
- data/lib/google-cloud-app_optimize-v1beta.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +593 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/cloud/appoptimize/v1beta/app_optimize.rb +328 -0
- data/proto_docs/google/longrunning/operations.rb +191 -0
- data/proto_docs/google/protobuf/any.rb +145 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/struct.rb +108 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- data/proto_docs/google/rpc/status.rb +48 -0
- metadata +83 -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,328 @@
|
|
|
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 Appoptimize
|
|
23
|
+
module V1beta
|
|
24
|
+
# Request message for the `CreateReport` method.
|
|
25
|
+
# @!attribute [rw] parent
|
|
26
|
+
# @return [::String]
|
|
27
|
+
# Required. The parent Google Cloud project that will own the report.
|
|
28
|
+
#
|
|
29
|
+
# This value does not define the scope of the report data. See `Report.scope`
|
|
30
|
+
# for setting the data scope.
|
|
31
|
+
#
|
|
32
|
+
# Format: `projects/{project}/locations/{location}`.
|
|
33
|
+
# @!attribute [rw] report_id
|
|
34
|
+
# @return [::String]
|
|
35
|
+
# Required. The ID to use for this report. This ID must be unique within
|
|
36
|
+
# the parent project and should comply with RFC 1034 restrictions (letters,
|
|
37
|
+
# numbers, and hyphen, with the first character a letter, the last a letter
|
|
38
|
+
# or a number, and a 63 character maximum).
|
|
39
|
+
# @!attribute [rw] report
|
|
40
|
+
# @return [::Google::Cloud::Appoptimize::V1beta::Report]
|
|
41
|
+
# Required. The report resource to create.
|
|
42
|
+
class CreateReportRequest
|
|
43
|
+
include ::Google::Protobuf::MessageExts
|
|
44
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# A configuration that defines the parameters for the data represented by a
|
|
48
|
+
# report.
|
|
49
|
+
# @!attribute [r] expire_time
|
|
50
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
51
|
+
# Output only. Timestamp in UTC of when this report expires. Once the
|
|
52
|
+
# report expires, it will no longer be accessible and the report's
|
|
53
|
+
# underlying data will be deleted.
|
|
54
|
+
# @!attribute [rw] name
|
|
55
|
+
# @return [::String]
|
|
56
|
+
# Identifier. The name of this report.
|
|
57
|
+
# @!attribute [rw] dimensions
|
|
58
|
+
# @return [::Array<::String>]
|
|
59
|
+
# Required. A list of dimensions to include in the report. Supported values:
|
|
60
|
+
#
|
|
61
|
+
# * `project`
|
|
62
|
+
# * `application`
|
|
63
|
+
# * `service_or_workload`
|
|
64
|
+
# * `resource`
|
|
65
|
+
# * `resource_type`
|
|
66
|
+
# * `location`
|
|
67
|
+
# * `product_display_name`
|
|
68
|
+
# * `sku`
|
|
69
|
+
# * `month`
|
|
70
|
+
# * `day`
|
|
71
|
+
# * `hour`
|
|
72
|
+
#
|
|
73
|
+
# To aggregate results by time, specify at least one time dimension
|
|
74
|
+
# (`month`, `day`, or `hour`). All time dimensions use Pacific Time,
|
|
75
|
+
# respect Daylight Saving Time (DST), and follow these ISO 8601 formats:
|
|
76
|
+
#
|
|
77
|
+
# * `month`: `YYYY-MM` (e.g., `2024-01`)
|
|
78
|
+
# * `day`: `YYYY-MM-DD` (e.g., `2024-01-10`)
|
|
79
|
+
# * `hour`: `YYYY-MM-DDTHH` (e.g., `2024-01-10T00`)
|
|
80
|
+
#
|
|
81
|
+
# If the time range filter does not align with the selected time dimension,
|
|
82
|
+
# the range is expanded to encompass the full period of the finest-grained
|
|
83
|
+
# time dimension.
|
|
84
|
+
#
|
|
85
|
+
# For example, if the filter is `2026-01-10` through `2026-01-12` and the
|
|
86
|
+
# `month` dimension is selected, the effective time range expands to include
|
|
87
|
+
# all of January (`2026-01-01` to `2026-02-01`).
|
|
88
|
+
# @!attribute [rw] metrics
|
|
89
|
+
# @return [::Array<::String>]
|
|
90
|
+
# Required. A list of metrics to include in the report. Supported values:
|
|
91
|
+
#
|
|
92
|
+
# * `cost`
|
|
93
|
+
# * `cpu_mean_utilization`
|
|
94
|
+
# * `cpu_usage_core_seconds`
|
|
95
|
+
# * `cpu_allocation_core_seconds`
|
|
96
|
+
# * `cpu_p95_utilization`
|
|
97
|
+
# * `memory_mean_utilization`
|
|
98
|
+
# * `memory_usage_byte_seconds`
|
|
99
|
+
# * `memory_allocation_byte_seconds`
|
|
100
|
+
# * `memory_p95_utilization`
|
|
101
|
+
# @!attribute [rw] scopes
|
|
102
|
+
# @return [::Array<::Google::Cloud::Appoptimize::V1beta::Scope>]
|
|
103
|
+
# Optional. The resource containers for which to fetch data. Default is the
|
|
104
|
+
# project specified in the report's parent.
|
|
105
|
+
# @!attribute [rw] filter
|
|
106
|
+
# @return [::String]
|
|
107
|
+
# Optional. A Common Expression Language (CEL) expression used to filter the
|
|
108
|
+
# data for the report.
|
|
109
|
+
#
|
|
110
|
+
# Predicates may refer to any dimension. Filtering must conform to these
|
|
111
|
+
# constraints:
|
|
112
|
+
#
|
|
113
|
+
# * All string field predicates must use exact string matches.
|
|
114
|
+
# * Multiple predicates referring to the same string field must be joined
|
|
115
|
+
# using the logical OR operator ('||').
|
|
116
|
+
# * All other predicates must be joined using the logical AND operator
|
|
117
|
+
# (`&&`).
|
|
118
|
+
# * A predicate on a time dimension (e.g., `day`) specifying the start time
|
|
119
|
+
# must use a greater-than-or-equal-to comparison (`>=`).
|
|
120
|
+
# * A predicate on a time dimension specifying the end time must use a
|
|
121
|
+
# less-than comparison (`<`).
|
|
122
|
+
#
|
|
123
|
+
# Examples:
|
|
124
|
+
#
|
|
125
|
+
# 1. Filter by a specific resource type:
|
|
126
|
+
# `"resource_type == 'compute.googleapis.com/Instance'"`
|
|
127
|
+
#
|
|
128
|
+
# 2. Filter data points that fall within a specific absolute time interval:
|
|
129
|
+
# `"hour >= timestamp('2024-01-01T00:00:00Z') &&
|
|
130
|
+
# hour < timestamp('2024-02-01T00:00:00Z')"`
|
|
131
|
+
#
|
|
132
|
+
# 3. Filter data points that fall within the past 72 hours:
|
|
133
|
+
# `"hour >= now - duration('72h')"`
|
|
134
|
+
#
|
|
135
|
+
# 4. Combine string predicate with time interval predicate:
|
|
136
|
+
# `"(location == 'us-east1' || location == 'us-west1') &&
|
|
137
|
+
# hour >= timestamp('2023-12-01T00:00:00Z') &&
|
|
138
|
+
# hour < timestamp('2024-02-01T00:00:00Z')"`
|
|
139
|
+
#
|
|
140
|
+
# If the filter omits time dimensions (`month`, `day`, `hour`), the report
|
|
141
|
+
# defaults to a 7-day range ending at the previous Pacific Time midnight,
|
|
142
|
+
# with Daylight Saving Time (DST) applied.
|
|
143
|
+
#
|
|
144
|
+
# For example, if the current Pacific Time is `2026-01-05T12:00:00`,
|
|
145
|
+
# the default range is `2025-12-29T00:00:00` to `2026-01-05T00:00:00` Pacific
|
|
146
|
+
# time.
|
|
147
|
+
class Report
|
|
148
|
+
include ::Google::Protobuf::MessageExts
|
|
149
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
# Specifies the report scope.
|
|
153
|
+
# @!attribute [rw] project
|
|
154
|
+
# @return [::String]
|
|
155
|
+
# Required. A Google Cloud Platform project to fetch data from.
|
|
156
|
+
#
|
|
157
|
+
# Format: `"projects/{project}"`.
|
|
158
|
+
#
|
|
159
|
+
# Note: The following fields are mutually exclusive: `project`, `application`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
160
|
+
# @!attribute [rw] application
|
|
161
|
+
# @return [::String]
|
|
162
|
+
# Required. An App Hub Application to fetch data from.
|
|
163
|
+
#
|
|
164
|
+
# Format:
|
|
165
|
+
# `"projects/{project}/locations/{location}/applications/{application}"`.
|
|
166
|
+
#
|
|
167
|
+
# Note: The following fields are mutually exclusive: `application`, `project`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
168
|
+
class Scope
|
|
169
|
+
include ::Google::Protobuf::MessageExts
|
|
170
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# Request message for the `GetReport` method.
|
|
174
|
+
# @!attribute [rw] name
|
|
175
|
+
# @return [::String]
|
|
176
|
+
# Required. The name of the report to retrieve.
|
|
177
|
+
#
|
|
178
|
+
# Format: `projects/{project}/locations/{location}/reports/{report_id}`.
|
|
179
|
+
class GetReportRequest
|
|
180
|
+
include ::Google::Protobuf::MessageExts
|
|
181
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
# Request message for the `ListReports` method.
|
|
185
|
+
# @!attribute [rw] parent
|
|
186
|
+
# @return [::String]
|
|
187
|
+
# Required. The parent project whose reports are to be listed.
|
|
188
|
+
#
|
|
189
|
+
# Format: `projects/{project}/locations/{location}`.
|
|
190
|
+
# @!attribute [rw] page_size
|
|
191
|
+
# @return [::Integer]
|
|
192
|
+
# Optional. The maximum number of reports to return. The service may return
|
|
193
|
+
# fewer than this value. If unspecified, the server will determine the number
|
|
194
|
+
# of results to return.
|
|
195
|
+
# @!attribute [rw] page_token
|
|
196
|
+
# @return [::String]
|
|
197
|
+
# Optional. A page token, received from a previous `ListReports` call.
|
|
198
|
+
# Provide this to retrieve the subsequent page.
|
|
199
|
+
#
|
|
200
|
+
# When paginating, all other parameters provided to `ListReports` must match
|
|
201
|
+
# the call that provided the page token.
|
|
202
|
+
class ListReportsRequest
|
|
203
|
+
include ::Google::Protobuf::MessageExts
|
|
204
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
# Response message for the `ListReports` method.
|
|
208
|
+
# @!attribute [rw] reports
|
|
209
|
+
# @return [::Array<::Google::Cloud::Appoptimize::V1beta::Report>]
|
|
210
|
+
# The list of reports.
|
|
211
|
+
# @!attribute [rw] next_page_token
|
|
212
|
+
# @return [::String]
|
|
213
|
+
# A token that can be sent as `page_token` to retrieve the next page.
|
|
214
|
+
# If this field is empty, there are no subsequent pages.
|
|
215
|
+
class ListReportsResponse
|
|
216
|
+
include ::Google::Protobuf::MessageExts
|
|
217
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
218
|
+
end
|
|
219
|
+
|
|
220
|
+
# Request message for the `DeleteReport` method.
|
|
221
|
+
# @!attribute [rw] name
|
|
222
|
+
# @return [::String]
|
|
223
|
+
# Required. The name of the report to delete.
|
|
224
|
+
#
|
|
225
|
+
# Format: `projects/{project}/locations/{location}/reports/{report_id}`.
|
|
226
|
+
# @!attribute [rw] allow_missing
|
|
227
|
+
# @return [::Boolean]
|
|
228
|
+
# Optional. If set to true, and the report is not found, the request will
|
|
229
|
+
# succeed but no action will be taken on the server.
|
|
230
|
+
class DeleteReportRequest
|
|
231
|
+
include ::Google::Protobuf::MessageExts
|
|
232
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
# Request message for the `ReadReport` method.
|
|
236
|
+
# @!attribute [rw] name
|
|
237
|
+
# @return [::String]
|
|
238
|
+
# Required. The resource name of the report to query.
|
|
239
|
+
#
|
|
240
|
+
# Format: `projects/{project}/locations/{location}/reports/{report_id}`.
|
|
241
|
+
# @!attribute [rw] page_size
|
|
242
|
+
# @return [::Integer]
|
|
243
|
+
# Optional. The maximum number of rows to return. The service may return
|
|
244
|
+
# fewer than this value. If unspecified, at most 10,000 rows will be returned
|
|
245
|
+
# per page. The maximum allowed value is 25,000; values above 25,000 are
|
|
246
|
+
# coerced to 25,000.
|
|
247
|
+
# @!attribute [rw] page_token
|
|
248
|
+
# @return [::String]
|
|
249
|
+
# Optional. A page token, received from a previous `ReadReport` call, to
|
|
250
|
+
# retrieve the subsequent page of results. When `page_token` is specified,
|
|
251
|
+
# `job_reference` must also be provided from the previous response, and the
|
|
252
|
+
# `statement` field must not be set.
|
|
253
|
+
class ReadReportRequest
|
|
254
|
+
include ::Google::Protobuf::MessageExts
|
|
255
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
256
|
+
end
|
|
257
|
+
|
|
258
|
+
# Response message for the `ReadReport` method.
|
|
259
|
+
# @!attribute [rw] rows
|
|
260
|
+
# @return [::Array<::Google::Protobuf::ListValue>]
|
|
261
|
+
# A list of rows, where each row represents a record from the report.
|
|
262
|
+
# @!attribute [rw] columns
|
|
263
|
+
# @return [::Array<::Google::Cloud::Appoptimize::V1beta::Column>]
|
|
264
|
+
# The columns describing the structure of the data in the `rows` field.
|
|
265
|
+
# @!attribute [rw] next_page_token
|
|
266
|
+
# @return [::String]
|
|
267
|
+
# A token that can be sent as `page_token` in a subsequent `ReadReport`
|
|
268
|
+
# request to retrieve the next page of results. If this field is empty,
|
|
269
|
+
# there are no further pages.
|
|
270
|
+
class ReadReportResponse
|
|
271
|
+
include ::Google::Protobuf::MessageExts
|
|
272
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
# Describes a single column within `Columns`.
|
|
276
|
+
# @!attribute [rw] name
|
|
277
|
+
# @return [::String]
|
|
278
|
+
# The name of the column.
|
|
279
|
+
#
|
|
280
|
+
# This field:
|
|
281
|
+
#
|
|
282
|
+
# * Contains only letters (a-z, A-Z), numbers (0-9), or underscores (_);
|
|
283
|
+
# * Start with a letter or underscore; and
|
|
284
|
+
# * Has a maximum length is 128 characters.
|
|
285
|
+
# @!attribute [rw] type
|
|
286
|
+
# @return [::String]
|
|
287
|
+
# The data type of the column.
|
|
288
|
+
#
|
|
289
|
+
# Supported values include:
|
|
290
|
+
#
|
|
291
|
+
# * `STRING`
|
|
292
|
+
# * `INT64`
|
|
293
|
+
# * `FLOAT64`
|
|
294
|
+
# * `BOOLEAN`
|
|
295
|
+
# * `TIMESTAMP`
|
|
296
|
+
# * `RECORD`
|
|
297
|
+
#
|
|
298
|
+
# `RECORD` indicates that the field contains a nested schema, described in
|
|
299
|
+
# the `columns` property of this `Column`.
|
|
300
|
+
# @!attribute [rw] mode
|
|
301
|
+
# @return [::String]
|
|
302
|
+
# The mode of the column, indicating if it is nullable, required, or
|
|
303
|
+
# repeated.
|
|
304
|
+
#
|
|
305
|
+
# Possible values:
|
|
306
|
+
#
|
|
307
|
+
# * `NULLABLE`: The column allows NULL values.
|
|
308
|
+
# * `REQUIRED`: The column does not allow NULL values.
|
|
309
|
+
# * `REPEATED`: The column contains an array of values.
|
|
310
|
+
# @!attribute [rw] columns
|
|
311
|
+
# @return [::Array<::Google::Cloud::Appoptimize::V1beta::Column>]
|
|
312
|
+
# If the `type` of this column is `RECORD`, this sub-field describes the
|
|
313
|
+
# nested structure.
|
|
314
|
+
class Column
|
|
315
|
+
include ::Google::Protobuf::MessageExts
|
|
316
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
317
|
+
end
|
|
318
|
+
|
|
319
|
+
# Represents metadata related to the creation of a Report. This value is
|
|
320
|
+
# embedded in the Operation object returned by `CreateReport`.
|
|
321
|
+
class OperationMetadata
|
|
322
|
+
include ::Google::Protobuf::MessageExts
|
|
323
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
324
|
+
end
|
|
325
|
+
end
|
|
326
|
+
end
|
|
327
|
+
end
|
|
328
|
+
end
|