google-cloud-vm_migration-v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +167 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google/cloud/vm_migration/v1/version.rb +28 -0
- data/lib/google/cloud/vm_migration/v1/vm_migration/client.rb +4999 -0
- data/lib/google/cloud/vm_migration/v1/vm_migration/credentials.rb +47 -0
- data/lib/google/cloud/vm_migration/v1/vm_migration/operations.rb +767 -0
- data/lib/google/cloud/vm_migration/v1/vm_migration/paths.rb +216 -0
- data/lib/google/cloud/vm_migration/v1/vm_migration.rb +50 -0
- data/lib/google/cloud/vm_migration/v1.rb +38 -0
- data/lib/google/cloud/vmmigration/v1/vmmigration_pb.rb +724 -0
- data/lib/google/cloud/vmmigration/v1/vmmigration_services_pb.rb +157 -0
- data/lib/google-cloud-vm_migration-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/cloud/vmmigration/v1/vmmigration.rb +2174 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/rpc/error_details.rb +297 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- metadata +218 -0
@@ -0,0 +1,157 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# Source: google/cloud/vmmigration/v1/vmmigration.proto for package 'Google.Cloud.VMMigration.V1'
|
3
|
+
# Original file comments:
|
4
|
+
# Copyright 2021 Google LLC
|
5
|
+
#
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
15
|
+
# See the License for the specific language governing permissions and
|
16
|
+
# limitations under the License.
|
17
|
+
#
|
18
|
+
|
19
|
+
require 'grpc'
|
20
|
+
require 'google/cloud/vmmigration/v1/vmmigration_pb'
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module VMMigration
|
25
|
+
module V1
|
26
|
+
module VmMigration
|
27
|
+
# VM Migration Service
|
28
|
+
class Service
|
29
|
+
|
30
|
+
include ::GRPC::GenericService
|
31
|
+
|
32
|
+
self.marshal_class_method = :encode
|
33
|
+
self.unmarshal_class_method = :decode
|
34
|
+
self.service_name = 'google.cloud.vmmigration.v1.VmMigration'
|
35
|
+
|
36
|
+
# Lists Sources in a given project and location.
|
37
|
+
rpc :ListSources, ::Google::Cloud::VMMigration::V1::ListSourcesRequest, ::Google::Cloud::VMMigration::V1::ListSourcesResponse
|
38
|
+
# Gets details of a single Source.
|
39
|
+
rpc :GetSource, ::Google::Cloud::VMMigration::V1::GetSourceRequest, ::Google::Cloud::VMMigration::V1::Source
|
40
|
+
# Creates a new Source in a given project and location.
|
41
|
+
rpc :CreateSource, ::Google::Cloud::VMMigration::V1::CreateSourceRequest, ::Google::Longrunning::Operation
|
42
|
+
# Updates the parameters of a single Source.
|
43
|
+
rpc :UpdateSource, ::Google::Cloud::VMMigration::V1::UpdateSourceRequest, ::Google::Longrunning::Operation
|
44
|
+
# Deletes a single Source.
|
45
|
+
rpc :DeleteSource, ::Google::Cloud::VMMigration::V1::DeleteSourceRequest, ::Google::Longrunning::Operation
|
46
|
+
# List remote source's inventory of VMs.
|
47
|
+
# The remote source is the onprem vCenter (remote in the sense it's not in
|
48
|
+
# Compute Engine). The inventory describes the list of existing VMs in that
|
49
|
+
# source. Note that this operation lists the VMs on the remote source, as
|
50
|
+
# opposed to listing the MigratingVms resources in the vmmigration service.
|
51
|
+
rpc :FetchInventory, ::Google::Cloud::VMMigration::V1::FetchInventoryRequest, ::Google::Cloud::VMMigration::V1::FetchInventoryResponse
|
52
|
+
# Lists Utilization Reports of the given Source.
|
53
|
+
rpc :ListUtilizationReports, ::Google::Cloud::VMMigration::V1::ListUtilizationReportsRequest, ::Google::Cloud::VMMigration::V1::ListUtilizationReportsResponse
|
54
|
+
# Gets a single Utilization Report.
|
55
|
+
rpc :GetUtilizationReport, ::Google::Cloud::VMMigration::V1::GetUtilizationReportRequest, ::Google::Cloud::VMMigration::V1::UtilizationReport
|
56
|
+
# Creates a new UtilizationReport.
|
57
|
+
rpc :CreateUtilizationReport, ::Google::Cloud::VMMigration::V1::CreateUtilizationReportRequest, ::Google::Longrunning::Operation
|
58
|
+
# Deletes a single Utilization Report.
|
59
|
+
rpc :DeleteUtilizationReport, ::Google::Cloud::VMMigration::V1::DeleteUtilizationReportRequest, ::Google::Longrunning::Operation
|
60
|
+
# Lists DatacenterConnectors in a given Source.
|
61
|
+
rpc :ListDatacenterConnectors, ::Google::Cloud::VMMigration::V1::ListDatacenterConnectorsRequest, ::Google::Cloud::VMMigration::V1::ListDatacenterConnectorsResponse
|
62
|
+
# Gets details of a single DatacenterConnector.
|
63
|
+
rpc :GetDatacenterConnector, ::Google::Cloud::VMMigration::V1::GetDatacenterConnectorRequest, ::Google::Cloud::VMMigration::V1::DatacenterConnector
|
64
|
+
# Creates a new DatacenterConnector in a given Source.
|
65
|
+
rpc :CreateDatacenterConnector, ::Google::Cloud::VMMigration::V1::CreateDatacenterConnectorRequest, ::Google::Longrunning::Operation
|
66
|
+
# Deletes a single DatacenterConnector.
|
67
|
+
rpc :DeleteDatacenterConnector, ::Google::Cloud::VMMigration::V1::DeleteDatacenterConnectorRequest, ::Google::Longrunning::Operation
|
68
|
+
# Creates a new MigratingVm in a given Source.
|
69
|
+
rpc :CreateMigratingVm, ::Google::Cloud::VMMigration::V1::CreateMigratingVmRequest, ::Google::Longrunning::Operation
|
70
|
+
# Lists MigratingVms in a given Source.
|
71
|
+
rpc :ListMigratingVms, ::Google::Cloud::VMMigration::V1::ListMigratingVmsRequest, ::Google::Cloud::VMMigration::V1::ListMigratingVmsResponse
|
72
|
+
# Gets details of a single MigratingVm.
|
73
|
+
rpc :GetMigratingVm, ::Google::Cloud::VMMigration::V1::GetMigratingVmRequest, ::Google::Cloud::VMMigration::V1::MigratingVm
|
74
|
+
# Updates the parameters of a single MigratingVm.
|
75
|
+
rpc :UpdateMigratingVm, ::Google::Cloud::VMMigration::V1::UpdateMigratingVmRequest, ::Google::Longrunning::Operation
|
76
|
+
# Deletes a single MigratingVm.
|
77
|
+
rpc :DeleteMigratingVm, ::Google::Cloud::VMMigration::V1::DeleteMigratingVmRequest, ::Google::Longrunning::Operation
|
78
|
+
# Starts migration for a VM. Starts the process of uploading
|
79
|
+
# data and creating snapshots, in replication cycles scheduled by the policy.
|
80
|
+
rpc :StartMigration, ::Google::Cloud::VMMigration::V1::StartMigrationRequest, ::Google::Longrunning::Operation
|
81
|
+
# Resumes a migration for a VM. When called on a paused migration, will start
|
82
|
+
# the process of uploading data and creating snapshots; when called on a
|
83
|
+
# completed cut-over migration, will update the migration to active state and
|
84
|
+
# start the process of uploading data and creating snapshots.
|
85
|
+
rpc :ResumeMigration, ::Google::Cloud::VMMigration::V1::ResumeMigrationRequest, ::Google::Longrunning::Operation
|
86
|
+
# Pauses a migration for a VM. If cycle tasks are running they will be
|
87
|
+
# cancelled, preserving source task data. Further replication cycles will not
|
88
|
+
# be triggered while the VM is paused.
|
89
|
+
rpc :PauseMigration, ::Google::Cloud::VMMigration::V1::PauseMigrationRequest, ::Google::Longrunning::Operation
|
90
|
+
# Marks a migration as completed, deleting migration resources that are no
|
91
|
+
# longer being used. Only applicable after cutover is done.
|
92
|
+
rpc :FinalizeMigration, ::Google::Cloud::VMMigration::V1::FinalizeMigrationRequest, ::Google::Longrunning::Operation
|
93
|
+
# Initiates a Clone of a specific migrating VM.
|
94
|
+
rpc :CreateCloneJob, ::Google::Cloud::VMMigration::V1::CreateCloneJobRequest, ::Google::Longrunning::Operation
|
95
|
+
# Initiates the cancellation of a running clone job.
|
96
|
+
rpc :CancelCloneJob, ::Google::Cloud::VMMigration::V1::CancelCloneJobRequest, ::Google::Longrunning::Operation
|
97
|
+
# Lists CloneJobs of a given migrating VM.
|
98
|
+
rpc :ListCloneJobs, ::Google::Cloud::VMMigration::V1::ListCloneJobsRequest, ::Google::Cloud::VMMigration::V1::ListCloneJobsResponse
|
99
|
+
# Gets details of a single CloneJob.
|
100
|
+
rpc :GetCloneJob, ::Google::Cloud::VMMigration::V1::GetCloneJobRequest, ::Google::Cloud::VMMigration::V1::CloneJob
|
101
|
+
# Initiates a Cutover of a specific migrating VM.
|
102
|
+
# The returned LRO is completed when the cutover job resource is created
|
103
|
+
# and the job is initiated.
|
104
|
+
rpc :CreateCutoverJob, ::Google::Cloud::VMMigration::V1::CreateCutoverJobRequest, ::Google::Longrunning::Operation
|
105
|
+
# Initiates the cancellation of a running cutover job.
|
106
|
+
rpc :CancelCutoverJob, ::Google::Cloud::VMMigration::V1::CancelCutoverJobRequest, ::Google::Longrunning::Operation
|
107
|
+
# Lists CutoverJobs of a given migrating VM.
|
108
|
+
rpc :ListCutoverJobs, ::Google::Cloud::VMMigration::V1::ListCutoverJobsRequest, ::Google::Cloud::VMMigration::V1::ListCutoverJobsResponse
|
109
|
+
# Gets details of a single CutoverJob.
|
110
|
+
rpc :GetCutoverJob, ::Google::Cloud::VMMigration::V1::GetCutoverJobRequest, ::Google::Cloud::VMMigration::V1::CutoverJob
|
111
|
+
# Lists Groups in a given project and location.
|
112
|
+
rpc :ListGroups, ::Google::Cloud::VMMigration::V1::ListGroupsRequest, ::Google::Cloud::VMMigration::V1::ListGroupsResponse
|
113
|
+
# Gets details of a single Group.
|
114
|
+
rpc :GetGroup, ::Google::Cloud::VMMigration::V1::GetGroupRequest, ::Google::Cloud::VMMigration::V1::Group
|
115
|
+
# Creates a new Group in a given project and location.
|
116
|
+
rpc :CreateGroup, ::Google::Cloud::VMMigration::V1::CreateGroupRequest, ::Google::Longrunning::Operation
|
117
|
+
# Updates the parameters of a single Group.
|
118
|
+
rpc :UpdateGroup, ::Google::Cloud::VMMigration::V1::UpdateGroupRequest, ::Google::Longrunning::Operation
|
119
|
+
# Deletes a single Group.
|
120
|
+
rpc :DeleteGroup, ::Google::Cloud::VMMigration::V1::DeleteGroupRequest, ::Google::Longrunning::Operation
|
121
|
+
# Adds a MigratingVm to a Group.
|
122
|
+
rpc :AddGroupMigration, ::Google::Cloud::VMMigration::V1::AddGroupMigrationRequest, ::Google::Longrunning::Operation
|
123
|
+
# Removes a MigratingVm from a Group.
|
124
|
+
rpc :RemoveGroupMigration, ::Google::Cloud::VMMigration::V1::RemoveGroupMigrationRequest, ::Google::Longrunning::Operation
|
125
|
+
# Lists TargetProjects in a given project.
|
126
|
+
#
|
127
|
+
# NOTE: TargetProject is a global resource; hence the only supported value
|
128
|
+
# for location is `global`.
|
129
|
+
rpc :ListTargetProjects, ::Google::Cloud::VMMigration::V1::ListTargetProjectsRequest, ::Google::Cloud::VMMigration::V1::ListTargetProjectsResponse
|
130
|
+
# Gets details of a single TargetProject.
|
131
|
+
#
|
132
|
+
# NOTE: TargetProject is a global resource; hence the only supported value
|
133
|
+
# for location is `global`.
|
134
|
+
rpc :GetTargetProject, ::Google::Cloud::VMMigration::V1::GetTargetProjectRequest, ::Google::Cloud::VMMigration::V1::TargetProject
|
135
|
+
# Creates a new TargetProject in a given project.
|
136
|
+
#
|
137
|
+
# NOTE: TargetProject is a global resource; hence the only supported value
|
138
|
+
# for location is `global`.
|
139
|
+
rpc :CreateTargetProject, ::Google::Cloud::VMMigration::V1::CreateTargetProjectRequest, ::Google::Longrunning::Operation
|
140
|
+
# Updates the parameters of a single TargetProject.
|
141
|
+
#
|
142
|
+
# NOTE: TargetProject is a global resource; hence the only supported value
|
143
|
+
# for location is `global`.
|
144
|
+
rpc :UpdateTargetProject, ::Google::Cloud::VMMigration::V1::UpdateTargetProjectRequest, ::Google::Longrunning::Operation
|
145
|
+
# Deletes a single TargetProject.
|
146
|
+
#
|
147
|
+
# NOTE: TargetProject is a global resource; hence the only supported value
|
148
|
+
# for location is `global`.
|
149
|
+
rpc :DeleteTargetProject, ::Google::Cloud::VMMigration::V1::DeleteTargetProjectRequest, ::Google::Longrunning::Operation
|
150
|
+
end
|
151
|
+
|
152
|
+
Stub = Service.rpc_stub_class
|
153
|
+
end
|
154
|
+
end
|
155
|
+
end
|
156
|
+
end
|
157
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 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
|
+
# This gem does not autoload during Bundler.require. To load this gem,
|
20
|
+
# issue explicit require statements for the packages desired, e.g.:
|
21
|
+
# require "google/cloud/vm_migration/v1"
|
@@ -0,0 +1,71 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 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
|
+
# An indicator of the behavior of a given field (for example, that a field
|
23
|
+
# is required in requests, or given as output but ignored as input).
|
24
|
+
# This **does not** change the behavior in protocol buffers itself; it only
|
25
|
+
# denotes the behavior and may affect how API tooling handles the field.
|
26
|
+
#
|
27
|
+
# Note: This enum **may** receive new values in the future.
|
28
|
+
module FieldBehavior
|
29
|
+
# Conventional default for enums. Do not use this.
|
30
|
+
FIELD_BEHAVIOR_UNSPECIFIED = 0
|
31
|
+
|
32
|
+
# Specifically denotes a field as optional.
|
33
|
+
# While all fields in protocol buffers are optional, this may be specified
|
34
|
+
# for emphasis if appropriate.
|
35
|
+
OPTIONAL = 1
|
36
|
+
|
37
|
+
# Denotes a field as required.
|
38
|
+
# This indicates that the field **must** be provided as part of the request,
|
39
|
+
# and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
|
40
|
+
REQUIRED = 2
|
41
|
+
|
42
|
+
# Denotes a field as output only.
|
43
|
+
# This indicates that the field is provided in responses, but including the
|
44
|
+
# field in a request does nothing (the server *must* ignore it and
|
45
|
+
# *must not* throw an error as a result of the field's presence).
|
46
|
+
OUTPUT_ONLY = 3
|
47
|
+
|
48
|
+
# Denotes a field as input only.
|
49
|
+
# This indicates that the field is provided in requests, and the
|
50
|
+
# corresponding field is not included in output.
|
51
|
+
INPUT_ONLY = 4
|
52
|
+
|
53
|
+
# Denotes a field as immutable.
|
54
|
+
# This indicates that the field may be set once in a request to create a
|
55
|
+
# resource, but may not be changed thereafter.
|
56
|
+
IMMUTABLE = 5
|
57
|
+
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
59
|
+
# This indicates that the service may provide the elements of the list
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
62
|
+
UNORDERED_LIST = 6
|
63
|
+
|
64
|
+
# Denotes that this field returns a non-empty default value if not set.
|
65
|
+
# This indicates that if the user provides the empty value in a request,
|
66
|
+
# a non-empty value will be returned. The user will not be aware of what
|
67
|
+
# non-empty value to expect.
|
68
|
+
NON_EMPTY_DEFAULT = 7
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
@@ -0,0 +1,283 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 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
|
+
# name_descriptor: {
|
37
|
+
# pattern: "projects/{project}/topics/{topic}"
|
38
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
+
# parent_name_extractor: "projects/{project}"
|
40
|
+
# }
|
41
|
+
# };
|
42
|
+
# }
|
43
|
+
#
|
44
|
+
# The ResourceDescriptor Yaml config will look like:
|
45
|
+
#
|
46
|
+
# resources:
|
47
|
+
# - type: "pubsub.googleapis.com/Topic"
|
48
|
+
# name_descriptor:
|
49
|
+
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
+
# parent_name_extractor: "projects/{project}"
|
52
|
+
#
|
53
|
+
# Sometimes, resources have multiple patterns, typically because they can
|
54
|
+
# live under multiple parents.
|
55
|
+
#
|
56
|
+
# Example:
|
57
|
+
#
|
58
|
+
# message LogEntry {
|
59
|
+
# option (google.api.resource) = {
|
60
|
+
# type: "logging.googleapis.com/LogEntry"
|
61
|
+
# name_descriptor: {
|
62
|
+
# pattern: "projects/{project}/logs/{log}"
|
63
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
64
|
+
# parent_name_extractor: "projects/{project}"
|
65
|
+
# }
|
66
|
+
# name_descriptor: {
|
67
|
+
# pattern: "folders/{folder}/logs/{log}"
|
68
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
69
|
+
# parent_name_extractor: "folders/{folder}"
|
70
|
+
# }
|
71
|
+
# name_descriptor: {
|
72
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
73
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
74
|
+
# parent_name_extractor: "organizations/{organization}"
|
75
|
+
# }
|
76
|
+
# name_descriptor: {
|
77
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
78
|
+
# parent_type: "billing.googleapis.com/BillingAccount"
|
79
|
+
# parent_name_extractor: "billingAccounts/{billing_account}"
|
80
|
+
# }
|
81
|
+
# };
|
82
|
+
# }
|
83
|
+
#
|
84
|
+
# The ResourceDescriptor Yaml config will look like:
|
85
|
+
#
|
86
|
+
# resources:
|
87
|
+
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
+
# name_descriptor:
|
89
|
+
# - pattern: "projects/{project}/logs/{log}"
|
90
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
91
|
+
# parent_name_extractor: "projects/{project}"
|
92
|
+
# - pattern: "folders/{folder}/logs/{log}"
|
93
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
94
|
+
# parent_name_extractor: "folders/{folder}"
|
95
|
+
# - pattern: "organizations/{organization}/logs/{log}"
|
96
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
97
|
+
# parent_name_extractor: "organizations/{organization}"
|
98
|
+
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
99
|
+
# parent_type: "billing.googleapis.com/BillingAccount"
|
100
|
+
# parent_name_extractor: "billingAccounts/{billing_account}"
|
101
|
+
#
|
102
|
+
# For flexible resources, the resource name doesn't contain parent names, but
|
103
|
+
# the resource itself has parents for policy evaluation.
|
104
|
+
#
|
105
|
+
# Example:
|
106
|
+
#
|
107
|
+
# message Shelf {
|
108
|
+
# option (google.api.resource) = {
|
109
|
+
# type: "library.googleapis.com/Shelf"
|
110
|
+
# name_descriptor: {
|
111
|
+
# pattern: "shelves/{shelf}"
|
112
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
113
|
+
# }
|
114
|
+
# name_descriptor: {
|
115
|
+
# pattern: "shelves/{shelf}"
|
116
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
117
|
+
# }
|
118
|
+
# };
|
119
|
+
# }
|
120
|
+
#
|
121
|
+
# The ResourceDescriptor Yaml config will look like:
|
122
|
+
#
|
123
|
+
# resources:
|
124
|
+
# - type: 'library.googleapis.com/Shelf'
|
125
|
+
# name_descriptor:
|
126
|
+
# - pattern: "shelves/{shelf}"
|
127
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
128
|
+
# - pattern: "shelves/{shelf}"
|
129
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
130
|
+
# @!attribute [rw] type
|
131
|
+
# @return [::String]
|
132
|
+
# The resource type. It must be in the format of
|
133
|
+
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
134
|
+
# singular and must not include version numbers.
|
135
|
+
#
|
136
|
+
# Example: `storage.googleapis.com/Bucket`
|
137
|
+
#
|
138
|
+
# The value of the resource_type_kind must follow the regular expression
|
139
|
+
# /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
|
140
|
+
# should use PascalCase (UpperCamelCase). The maximum number of
|
141
|
+
# characters allowed for the `resource_type_kind` is 100.
|
142
|
+
# @!attribute [rw] pattern
|
143
|
+
# @return [::Array<::String>]
|
144
|
+
# Optional. The relative resource name pattern associated with this resource
|
145
|
+
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
146
|
+
#
|
147
|
+
# The path pattern must follow the syntax, which aligns with HTTP binding
|
148
|
+
# syntax:
|
149
|
+
#
|
150
|
+
# Template = Segment { "/" Segment } ;
|
151
|
+
# Segment = LITERAL | Variable ;
|
152
|
+
# Variable = "{" LITERAL "}" ;
|
153
|
+
#
|
154
|
+
# Examples:
|
155
|
+
#
|
156
|
+
# - "projects/\\{project}/topics/\\{topic}"
|
157
|
+
# - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
|
158
|
+
#
|
159
|
+
# The components in braces correspond to the IDs for each resource in the
|
160
|
+
# hierarchy. It is expected that, if multiple patterns are provided,
|
161
|
+
# the same component name (e.g. "project") refers to IDs of the same
|
162
|
+
# type of resource.
|
163
|
+
# @!attribute [rw] name_field
|
164
|
+
# @return [::String]
|
165
|
+
# Optional. The field on the resource that designates the resource name
|
166
|
+
# field. If omitted, this is assumed to be "name".
|
167
|
+
# @!attribute [rw] history
|
168
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
169
|
+
# Optional. The historical or future-looking state of the resource pattern.
|
170
|
+
#
|
171
|
+
# Example:
|
172
|
+
#
|
173
|
+
# // The InspectTemplate message originally only supported resource
|
174
|
+
# // names with organization, and project was added later.
|
175
|
+
# message InspectTemplate {
|
176
|
+
# option (google.api.resource) = {
|
177
|
+
# type: "dlp.googleapis.com/InspectTemplate"
|
178
|
+
# pattern:
|
179
|
+
# "organizations/{organization}/inspectTemplates/{inspect_template}"
|
180
|
+
# pattern: "projects/{project}/inspectTemplates/{inspect_template}"
|
181
|
+
# history: ORIGINALLY_SINGLE_PATTERN
|
182
|
+
# };
|
183
|
+
# }
|
184
|
+
# @!attribute [rw] plural
|
185
|
+
# @return [::String]
|
186
|
+
# The plural name used in the resource name and permission names, such as
|
187
|
+
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
188
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
|
189
|
+
# concept of the `plural` field in k8s CRD spec
|
190
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
191
|
+
#
|
192
|
+
# Note: The plural form is required even for singleton resources. See
|
193
|
+
# https://aip.dev/156
|
194
|
+
# @!attribute [rw] singular
|
195
|
+
# @return [::String]
|
196
|
+
# The same concept of the `singular` field in k8s CRD spec
|
197
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
198
|
+
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
199
|
+
# @!attribute [rw] style
|
200
|
+
# @return [::Array<::Google::Api::ResourceDescriptor::Style>]
|
201
|
+
# Style flag(s) for this resource.
|
202
|
+
# These indicate that a resource is expected to conform to a given
|
203
|
+
# style. See the specific style flags for additional information.
|
204
|
+
class ResourceDescriptor
|
205
|
+
include ::Google::Protobuf::MessageExts
|
206
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
207
|
+
|
208
|
+
# A description of the historical or future-looking state of the
|
209
|
+
# resource pattern.
|
210
|
+
module History
|
211
|
+
# The "unset" value.
|
212
|
+
HISTORY_UNSPECIFIED = 0
|
213
|
+
|
214
|
+
# The resource originally had one pattern and launched as such, and
|
215
|
+
# additional patterns were added later.
|
216
|
+
ORIGINALLY_SINGLE_PATTERN = 1
|
217
|
+
|
218
|
+
# The resource has one pattern, but the API owner expects to add more
|
219
|
+
# later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
|
220
|
+
# that from being necessary once there are multiple patterns.)
|
221
|
+
FUTURE_MULTI_PATTERN = 2
|
222
|
+
end
|
223
|
+
|
224
|
+
# A flag representing a specific style that a resource claims to conform to.
|
225
|
+
module Style
|
226
|
+
# The unspecified value. Do not use.
|
227
|
+
STYLE_UNSPECIFIED = 0
|
228
|
+
|
229
|
+
# This resource is intended to be "declarative-friendly".
|
230
|
+
#
|
231
|
+
# Declarative-friendly resources must be more strictly consistent, and
|
232
|
+
# setting this to true communicates to tools that this resource should
|
233
|
+
# adhere to declarative-friendly expectations.
|
234
|
+
#
|
235
|
+
# Note: This is used by the API linter (linter.aip.dev) to enable
|
236
|
+
# additional checks.
|
237
|
+
DECLARATIVE_FRIENDLY = 1
|
238
|
+
end
|
239
|
+
end
|
240
|
+
|
241
|
+
# Defines a proto annotation that describes a string field that refers to
|
242
|
+
# an API resource.
|
243
|
+
# @!attribute [rw] type
|
244
|
+
# @return [::String]
|
245
|
+
# The resource type that the annotated field references.
|
246
|
+
#
|
247
|
+
# Example:
|
248
|
+
#
|
249
|
+
# message Subscription {
|
250
|
+
# string topic = 2 [(google.api.resource_reference) = {
|
251
|
+
# type: "pubsub.googleapis.com/Topic"
|
252
|
+
# }];
|
253
|
+
# }
|
254
|
+
#
|
255
|
+
# Occasionally, a field may reference an arbitrary resource. In this case,
|
256
|
+
# APIs use the special value * in their resource reference.
|
257
|
+
#
|
258
|
+
# Example:
|
259
|
+
#
|
260
|
+
# message GetIamPolicyRequest {
|
261
|
+
# string resource = 2 [(google.api.resource_reference) = {
|
262
|
+
# type: "*"
|
263
|
+
# }];
|
264
|
+
# }
|
265
|
+
# @!attribute [rw] child_type
|
266
|
+
# @return [::String]
|
267
|
+
# The resource type of a child collection that the annotated field
|
268
|
+
# references. This is useful for annotating the `parent` field that
|
269
|
+
# doesn't have a fixed resource type.
|
270
|
+
#
|
271
|
+
# Example:
|
272
|
+
#
|
273
|
+
# message ListLogEntriesRequest {
|
274
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
275
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
276
|
+
# };
|
277
|
+
# }
|
278
|
+
class ResourceReference
|
279
|
+
include ::Google::Protobuf::MessageExts
|
280
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
281
|
+
end
|
282
|
+
end
|
283
|
+
end
|