| { |
| "name": "datamigration", |
| "kind": "discovery#restDescription", |
| "parameters": { |
| "key": { |
| "location": "query", |
| "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
| "type": "string" |
| }, |
| "access_token": { |
| "description": "OAuth access token.", |
| "type": "string", |
| "location": "query" |
| }, |
| "prettyPrint": { |
| "location": "query", |
| "type": "boolean", |
| "default": "true", |
| "description": "Returns response with indentations and line breaks." |
| }, |
| "quotaUser": { |
| "location": "query", |
| "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
| "type": "string" |
| }, |
| "oauth_token": { |
| "type": "string", |
| "location": "query", |
| "description": "OAuth 2.0 token for the current user." |
| }, |
| "alt": { |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "type": "string", |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "default": "json", |
| "location": "query", |
| "description": "Data format for response." |
| }, |
| "fields": { |
| "description": "Selector specifying which fields to include in a partial response.", |
| "type": "string", |
| "location": "query" |
| }, |
| "uploadType": { |
| "location": "query", |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "type": "string" |
| }, |
| "$.xgafv": { |
| "type": "string", |
| "description": "V1 error format.", |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "location": "query", |
| "enum": [ |
| "1", |
| "2" |
| ] |
| }, |
| "upload_protocol": { |
| "location": "query", |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "type": "string" |
| }, |
| "callback": { |
| "description": "JSONP", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "fullyEncodeReservedExpansion": true, |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/cloud-platform": { |
| "description": "View and manage your data across Google Cloud Platform services" |
| } |
| } |
| } |
| }, |
| "schemas": { |
| "SqlAclEntry": { |
| "id": "SqlAclEntry", |
| "properties": { |
| "value": { |
| "type": "string", |
| "description": "The allowlisted value for the access control list." |
| }, |
| "expireTime": { |
| "type": "string", |
| "format": "google-datetime", |
| "description": "The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`." |
| }, |
| "label": { |
| "description": "A label to identify this entry.", |
| "type": "string" |
| }, |
| "ttl": { |
| "description": "Input only. The time-to-leave of this access control entry.", |
| "type": "string", |
| "format": "google-duration" |
| } |
| }, |
| "description": "An entry for an Access Control list.", |
| "type": "object" |
| }, |
| "TestIamPermissionsRequest": { |
| "id": "TestIamPermissionsRequest", |
| "type": "object", |
| "properties": { |
| "permissions": { |
| "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "description": "Request message for `TestIamPermissions` method." |
| }, |
| "VerifyMigrationJobRequest": { |
| "description": "Request message for 'VerifyMigrationJob' request.", |
| "properties": {}, |
| "id": "VerifyMigrationJobRequest", |
| "type": "object" |
| }, |
| "ListOperationsResponse": { |
| "type": "object", |
| "id": "ListOperationsResponse", |
| "description": "The response message for Operations.ListOperations.", |
| "properties": { |
| "nextPageToken": { |
| "description": "The standard List next-page token.", |
| "type": "string" |
| }, |
| "operations": { |
| "items": { |
| "$ref": "Operation" |
| }, |
| "type": "array", |
| "description": "A list of operations that matches the specified filter in the request." |
| } |
| } |
| }, |
| "VmCreationConfig": { |
| "type": "object", |
| "description": "VM creation configuration message", |
| "id": "VmCreationConfig", |
| "properties": { |
| "vmMachineType": { |
| "type": "string", |
| "description": "Required. VM instance machine type to create." |
| }, |
| "vmZone": { |
| "description": "The Google Cloud Platform zone to create the VM in.", |
| "type": "string" |
| }, |
| "subnet": { |
| "description": "The subnet name the vm needs to be created in.", |
| "type": "string" |
| } |
| } |
| }, |
| "StartMigrationJobRequest": { |
| "type": "object", |
| "properties": {}, |
| "description": "Request message for 'StartMigrationJob' request.", |
| "id": "StartMigrationJobRequest" |
| }, |
| "DatabaseType": { |
| "id": "DatabaseType", |
| "properties": { |
| "provider": { |
| "type": "string", |
| "enum": [ |
| "DATABASE_PROVIDER_UNSPECIFIED", |
| "CLOUDSQL", |
| "RDS" |
| ], |
| "description": "The database provider.", |
| "enumDescriptions": [ |
| "The database provider is unknown.", |
| "CloudSQL runs the database.", |
| "RDS runs the database." |
| ] |
| }, |
| "engine": { |
| "type": "string", |
| "enumDescriptions": [ |
| "The source database engine of the migration job is unknown.", |
| "The source engine is MySQL." |
| ], |
| "enum": [ |
| "DATABASE_ENGINE_UNSPECIFIED", |
| "MYSQL" |
| ], |
| "description": "The database engine." |
| } |
| }, |
| "type": "object", |
| "description": "A message defining the database engine and provider." |
| }, |
| "Location": { |
| "description": "A resource that represents Google Cloud Platform location.", |
| "type": "object", |
| "id": "Location", |
| "properties": { |
| "displayName": { |
| "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", |
| "type": "string" |
| }, |
| "labels": { |
| "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "type": "object" |
| }, |
| "metadata": { |
| "type": "object", |
| "description": "Service-specific metadata. For example the available capacity at the given location.", |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| } |
| }, |
| "locationId": { |
| "type": "string", |
| "description": "The canonical id for this location. For example: `\"us-east1\"`." |
| }, |
| "name": { |
| "type": "string", |
| "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" |
| } |
| } |
| }, |
| "VpcPeeringConnectivity": { |
| "properties": { |
| "vpc": { |
| "type": "string", |
| "description": "The name of the VPC network to peer with the Cloud SQL private network." |
| } |
| }, |
| "id": "VpcPeeringConnectivity", |
| "type": "object", |
| "description": "The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC." |
| }, |
| "Policy": { |
| "id": "Policy", |
| "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:[email protected]\", \"group:[email protected]\", \"domain:google.com\", \"serviceAccount:[email protected]\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:[email protected]\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", |
| "properties": { |
| "etag": { |
| "type": "string", |
| "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", |
| "format": "byte" |
| }, |
| "bindings": { |
| "items": { |
| "$ref": "Binding" |
| }, |
| "type": "array", |
| "description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member." |
| }, |
| "version": { |
| "format": "int32", |
| "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", |
| "type": "integer" |
| }, |
| "auditConfigs": { |
| "type": "array", |
| "description": "Specifies cloud audit logging configuration for this policy.", |
| "items": { |
| "$ref": "AuditConfig" |
| } |
| } |
| }, |
| "type": "object" |
| }, |
| "SshScript": { |
| "type": "object", |
| "properties": { |
| "script": { |
| "type": "string", |
| "description": "The ssh configuration script." |
| } |
| }, |
| "description": "Response message for 'GenerateSshScript' request.", |
| "id": "SshScript" |
| }, |
| "SqlIpConfig": { |
| "id": "SqlIpConfig", |
| "type": "object", |
| "description": "IP Management configuration.", |
| "properties": { |
| "requireSsl": { |
| "type": "boolean", |
| "description": "Whether SSL connections over IP should be enforced or not." |
| }, |
| "authorizedNetworks": { |
| "type": "array", |
| "items": { |
| "$ref": "SqlAclEntry" |
| }, |
| "description": "The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. `192.168.100.0/24`)." |
| }, |
| "enableIpv4": { |
| "description": "Whether the instance should be assigned an IPv4 address or not.", |
| "type": "boolean" |
| }, |
| "privateNetwork": { |
| "type": "string", |
| "description": "The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set." |
| } |
| } |
| }, |
| "Binding": { |
| "id": "Binding", |
| "description": "Associates `members` with a `role`.", |
| "properties": { |
| "bindingId": { |
| "type": "string" |
| }, |
| "role": { |
| "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", |
| "type": "string" |
| }, |
| "members": { |
| "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "condition": { |
| "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", |
| "$ref": "Expr" |
| } |
| }, |
| "type": "object" |
| }, |
| "RestartMigrationJobRequest": { |
| "type": "object", |
| "id": "RestartMigrationJobRequest", |
| "description": "Request message for 'RestartMigrationJob' request.", |
| "properties": {} |
| }, |
| "CloudSqlConnectionProfile": { |
| "type": "object", |
| "properties": { |
| "settings": { |
| "$ref": "CloudSqlSettings", |
| "description": "Immutable. Metadata used to create the destination Cloud SQL database." |
| }, |
| "publicIp": { |
| "description": "Output only. The Cloud SQL database instance's public IP.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "privateIp": { |
| "description": "Output only. The Cloud SQL database instance's private IP.", |
| "type": "string", |
| "readOnly": true |
| }, |
| "cloudSqlId": { |
| "type": "string", |
| "readOnly": true, |
| "description": "Output only. The Cloud SQL instance ID that this connection profile is associated with." |
| } |
| }, |
| "description": "Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance.", |
| "id": "CloudSqlConnectionProfile" |
| }, |
| "AuditConfig": { |
| "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:[email protected]\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:[email protected]\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging.", |
| "type": "object", |
| "id": "AuditConfig", |
| "properties": { |
| "service": { |
| "type": "string", |
| "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services." |
| }, |
| "auditLogConfigs": { |
| "description": "The configuration for logging of each type of permission.", |
| "items": { |
| "$ref": "AuditLogConfig" |
| }, |
| "type": "array" |
| } |
| } |
| }, |
| "SetIamPolicyRequest": { |
| "type": "object", |
| "properties": { |
| "policy": { |
| "$ref": "Policy", |
| "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them." |
| }, |
| "updateMask": { |
| "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", |
| "format": "google-fieldmask", |
| "type": "string" |
| } |
| }, |
| "id": "SetIamPolicyRequest", |
| "description": "Request message for `SetIamPolicy` method." |
| }, |
| "ListMigrationJobsResponse": { |
| "id": "ListMigrationJobsResponse", |
| "description": "Response message for 'ListMigrationJobs' request.", |
| "type": "object", |
| "properties": { |
| "migrationJobs": { |
| "items": { |
| "$ref": "MigrationJob" |
| }, |
| "description": "The list of migration jobs objects.", |
| "type": "array" |
| }, |
| "nextPageToken": { |
| "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", |
| "type": "string" |
| }, |
| "unreachable": { |
| "items": { |
| "type": "string" |
| }, |
| "description": "Locations that could not be reached.", |
| "type": "array" |
| } |
| } |
| }, |
| "ReverseSshConnectivity": { |
| "id": "ReverseSshConnectivity", |
| "properties": { |
| "vpc": { |
| "description": "The name of the VPC to peer with the Cloud SQL private network.", |
| "type": "string" |
| }, |
| "vm": { |
| "description": "The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.", |
| "type": "string" |
| }, |
| "vmIp": { |
| "description": "Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.", |
| "type": "string" |
| }, |
| "vmPort": { |
| "format": "int32", |
| "type": "integer", |
| "description": "Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel." |
| } |
| }, |
| "description": "The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1beta1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC.", |
| "type": "object" |
| }, |
| "AuditLogConfig": { |
| "properties": { |
| "exemptedMembers": { |
| "type": "array", |
| "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "logType": { |
| "enumDescriptions": [ |
| "Default case. Should never be this.", |
| "Admin reads. Example: CloudIAM getIamPolicy", |
| "Data writes. Example: CloudSQL Users create", |
| "Data reads. Example: CloudSQL Users list" |
| ], |
| "description": "The log type that this config enables.", |
| "type": "string", |
| "enum": [ |
| "LOG_TYPE_UNSPECIFIED", |
| "ADMIN_READ", |
| "DATA_WRITE", |
| "DATA_READ" |
| ] |
| } |
| }, |
| "type": "object", |
| "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:[email protected]\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging.", |
| "id": "AuditLogConfig" |
| }, |
| "Operation": { |
| "type": "object", |
| "description": "This resource represents a long-running operation that is the result of a network API call.", |
| "properties": { |
| "error": { |
| "$ref": "Status", |
| "description": "The error result of the operation in case of failure or cancellation." |
| }, |
| "name": { |
| "type": "string", |
| "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." |
| }, |
| "response": { |
| "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", |
| "type": "object", |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| } |
| }, |
| "metadata": { |
| "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "type": "object" |
| }, |
| "done": { |
| "type": "boolean", |
| "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available." |
| } |
| }, |
| "id": "Operation" |
| }, |
| "ConnectionProfile": { |
| "id": "ConnectionProfile", |
| "properties": { |
| "labels": { |
| "description": "The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of \"key\": \"value\" pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`.", |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "type": "object" |
| }, |
| "provider": { |
| "enumDescriptions": [ |
| "The database provider is unknown.", |
| "CloudSQL runs the database.", |
| "RDS runs the database." |
| ], |
| "description": "The database provider.", |
| "enum": [ |
| "DATABASE_PROVIDER_UNSPECIFIED", |
| "CLOUDSQL", |
| "RDS" |
| ], |
| "type": "string" |
| }, |
| "state": { |
| "enumDescriptions": [ |
| "The state of the connection profile is unknown.", |
| "The connection profile is in draft mode and fully editable.", |
| "The connection profile is being created.", |
| "The connection profile is ready.", |
| "The connection profile is being updated.", |
| "The connection profile is being deleted.", |
| "The connection profile has been deleted.", |
| "The last action on the connection profile failed." |
| ], |
| "description": "The current connection profile state (e.g. DRAFT, READY, or FAILED).", |
| "type": "string", |
| "enum": [ |
| "STATE_UNSPECIFIED", |
| "DRAFT", |
| "CREATING", |
| "READY", |
| "UPDATING", |
| "DELETING", |
| "DELETED", |
| "FAILED" |
| ] |
| }, |
| "cloudsql": { |
| "description": "A CloudSQL database connection profile.", |
| "$ref": "CloudSqlConnectionProfile" |
| }, |
| "name": { |
| "description": "The name of this connection profile resource in the form of projects/{project}/locations/{location}/instances/{instance}.", |
| "type": "string" |
| }, |
| "mysql": { |
| "description": "A MySQL database connection profile.", |
| "$ref": "MySqlConnectionProfile" |
| }, |
| "updateTime": { |
| "format": "google-datetime", |
| "type": "string", |
| "description": "Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\".", |
| "readOnly": true |
| }, |
| "displayName": { |
| "description": "The connection profile display name.", |
| "type": "string" |
| }, |
| "createTime": { |
| "format": "google-datetime", |
| "type": "string", |
| "readOnly": true, |
| "description": "Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\"." |
| }, |
| "error": { |
| "$ref": "Status", |
| "readOnly": true, |
| "description": "Output only. The error details in case of state FAILED." |
| } |
| }, |
| "type": "object", |
| "description": "A connection profile definition." |
| }, |
| "ResumeMigrationJobRequest": { |
| "properties": {}, |
| "type": "object", |
| "description": "Request message for 'ResumeMigrationJob' request.", |
| "id": "ResumeMigrationJobRequest" |
| }, |
| "ListLocationsResponse": { |
| "type": "object", |
| "description": "The response message for Locations.ListLocations.", |
| "properties": { |
| "locations": { |
| "items": { |
| "$ref": "Location" |
| }, |
| "type": "array", |
| "description": "A list of locations that matches the specified filter in the request." |
| }, |
| "nextPageToken": { |
| "description": "The standard List next-page token.", |
| "type": "string" |
| } |
| }, |
| "id": "ListLocationsResponse" |
| }, |
| "Status": { |
| "type": "object", |
| "id": "Status", |
| "properties": { |
| "message": { |
| "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", |
| "type": "string" |
| }, |
| "details": { |
| "items": { |
| "additionalProperties": { |
| "type": "any", |
| "description": "Properties of the object. Contains field @type with type URL." |
| }, |
| "type": "object" |
| }, |
| "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", |
| "type": "array" |
| }, |
| "code": { |
| "description": "The status code, which should be an enum value of google.rpc.Code.", |
| "type": "integer", |
| "format": "int32" |
| } |
| }, |
| "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)." |
| }, |
| "TestIamPermissionsResponse": { |
| "id": "TestIamPermissionsResponse", |
| "type": "object", |
| "properties": { |
| "permissions": { |
| "items": { |
| "type": "string" |
| }, |
| "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", |
| "type": "array" |
| } |
| }, |
| "description": "Response message for `TestIamPermissions` method." |
| }, |
| "VmSelectionConfig": { |
| "id": "VmSelectionConfig", |
| "type": "object", |
| "properties": { |
| "vmZone": { |
| "type": "string", |
| "description": "Required. The Google Cloud Platform zone the VM is located." |
| } |
| }, |
| "description": "VM selection configuration message" |
| }, |
| "GenerateSshScriptRequest": { |
| "type": "object", |
| "properties": { |
| "vmPort": { |
| "description": "The port that will be open on the bastion host", |
| "type": "integer", |
| "format": "int32" |
| }, |
| "vmCreationConfig": { |
| "$ref": "VmCreationConfig", |
| "description": "The VM creation configuration" |
| }, |
| "vmSelectionConfig": { |
| "description": "The VM selection configuration", |
| "$ref": "VmSelectionConfig" |
| }, |
| "vm": { |
| "description": "Required. Bastion VM Instance name to use or to create.", |
| "type": "string" |
| } |
| }, |
| "id": "GenerateSshScriptRequest", |
| "description": "Request message for 'GenerateSshScript' request." |
| }, |
| "MySqlConnectionProfile": { |
| "id": "MySqlConnectionProfile", |
| "description": "Specifies connection parameters required specifically for MySQL databases.", |
| "properties": { |
| "port": { |
| "type": "integer", |
| "format": "int32", |
| "description": "Required. The network port of the source MySQL database." |
| }, |
| "cloudSqlId": { |
| "type": "string", |
| "description": "If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source." |
| }, |
| "username": { |
| "type": "string", |
| "description": "Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service." |
| }, |
| "ssl": { |
| "$ref": "SslConfig", |
| "description": "SSL configuration for the destination to connect to the source database." |
| }, |
| "host": { |
| "description": "Required. The IP or hostname of the source MySQL database.", |
| "type": "string" |
| }, |
| "password": { |
| "type": "string", |
| "description": "Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service." |
| }, |
| "passwordSet": { |
| "readOnly": true, |
| "description": "Output only. Indicates If this connection profile password is stored.", |
| "type": "boolean" |
| } |
| }, |
| "type": "object" |
| }, |
| "CloudSqlSettings": { |
| "type": "object", |
| "description": "Settings for creating a Cloud SQL database instance.", |
| "properties": { |
| "dataDiskType": { |
| "enum": [ |
| "SQL_DATA_DISK_TYPE_UNSPECIFIED", |
| "PD_SSD", |
| "PD_HDD" |
| ], |
| "type": "string", |
| "description": "The type of storage: `PD_SSD` (default) or `PD_HDD`.", |
| "enumDescriptions": [ |
| "Unspecified.", |
| "SSD disk.", |
| "HDD disk." |
| ] |
| }, |
| "tier": { |
| "type": "string", |
| "description": "The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances) or `db-custom-1-3840` (PostgreSQL instances). For more information, see [Cloud SQL Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings)." |
| }, |
| "rootPassword": { |
| "description": "Input only. Initial root password.", |
| "type": "string" |
| }, |
| "activationPolicy": { |
| "description": "The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives.", |
| "type": "string", |
| "enumDescriptions": [ |
| "unspecified policy.", |
| "The instance is always up and running.", |
| "The instance should never spin up." |
| ], |
| "enum": [ |
| "SQL_ACTIVATION_POLICY_UNSPECIFIED", |
| "ALWAYS", |
| "NEVER" |
| ] |
| }, |
| "userLabels": { |
| "type": "object", |
| "description": "The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of \"key\": \"value\" pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"18kg\", \"count\": \"3\" }`.", |
| "additionalProperties": { |
| "type": "string" |
| } |
| }, |
| "zone": { |
| "type": "string", |
| "description": "The Google Cloud Platform zone where your Cloud SQL datdabse instance is located." |
| }, |
| "storageAutoResizeLimit": { |
| "type": "string", |
| "format": "int64", |
| "description": "The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit." |
| }, |
| "sourceId": { |
| "description": "The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`", |
| "type": "string" |
| }, |
| "rootPasswordSet": { |
| "description": "Output only. Indicates If this connection profile root password is stored.", |
| "type": "boolean", |
| "readOnly": true |
| }, |
| "autoStorageIncrease": { |
| "type": "boolean", |
| "description": "[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB." |
| }, |
| "databaseFlags": { |
| "type": "object", |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "description": "The database flags passed to the Cloud SQL instance at startup. An object containing a list of \"key\": value pairs. Example: { \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }." |
| }, |
| "ipConfig": { |
| "description": "The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.", |
| "$ref": "SqlIpConfig" |
| }, |
| "dataDiskSizeGb": { |
| "description": "The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "databaseVersion": { |
| "description": "The database engine type and version (such as `MYSQL_5_7` / `POSTGRES_9_6`).", |
| "enumDescriptions": [ |
| "Unspecified version.", |
| "MySQL 5.6.", |
| "MySQL 5.7.", |
| "MySQL 8.0." |
| ], |
| "type": "string", |
| "enum": [ |
| "SQL_DATABASE_VERSION_UNSPECIFIED", |
| "MYSQL_5_6", |
| "MYSQL_5_7", |
| "MYSQL_8_0" |
| ] |
| } |
| }, |
| "id": "CloudSqlSettings" |
| }, |
| "Expr": { |
| "id": "Expr", |
| "properties": { |
| "title": { |
| "type": "string", |
| "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression." |
| }, |
| "expression": { |
| "description": "Textual representation of an expression in Common Expression Language syntax.", |
| "type": "string" |
| }, |
| "description": { |
| "type": "string", |
| "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI." |
| }, |
| "location": { |
| "type": "string", |
| "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file." |
| } |
| }, |
| "type": "object", |
| "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information." |
| }, |
| "PromoteMigrationJobRequest": { |
| "id": "PromoteMigrationJobRequest", |
| "properties": {}, |
| "description": "Request message for 'PromoteMigrationJob' request.", |
| "type": "object" |
| }, |
| "SslConfig": { |
| "type": "object", |
| "description": "SSL configuration information.", |
| "properties": { |
| "clientCertificate": { |
| "description": "Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.", |
| "type": "string" |
| }, |
| "clientKey": { |
| "type": "string", |
| "description": "Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory." |
| }, |
| "type": { |
| "readOnly": true, |
| "type": "string", |
| "enumDescriptions": [ |
| "Unspecified.", |
| "Only 'ca_certificate' specified.", |
| "Both server ('ca_certificate'), and client ('client_key', 'client_certificate') specified." |
| ], |
| "enum": [ |
| "SSL_TYPE_UNSPECIFIED", |
| "SERVER_ONLY", |
| "SERVER_CLIENT" |
| ], |
| "description": "Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'." |
| }, |
| "caCertificate": { |
| "description": "Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.", |
| "type": "string" |
| } |
| }, |
| "id": "SslConfig" |
| }, |
| "StaticIpConnectivity": { |
| "properties": {}, |
| "description": "The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required.", |
| "type": "object", |
| "id": "StaticIpConnectivity" |
| }, |
| "MigrationJobVerificationError": { |
| "type": "object", |
| "properties": { |
| "errorCode": { |
| "type": "string", |
| "enumDescriptions": [ |
| "An unknown error occurred", |
| "We failed to connect to one of the connection profile.", |
| "We failed to authenticate to one of the connection profile.", |
| "One of the involved connection profiles has an invalid configuration.", |
| "The versions of the source and the destination are incompatible.", |
| "The types of the source and the destination are incompatible.", |
| "The gtid_mode is not supported, applicable for MySQL.", |
| "The definer is not supported." |
| ], |
| "readOnly": true, |
| "description": "Output only. An instance of ErrorCode specifying the error that occurred.", |
| "enum": [ |
| "ERROR_CODE_UNSPECIFIED", |
| "CONNECTION_FAILURE", |
| "AUTHENTICATION_FAILURE", |
| "INVALID_CONNECTION_PROFILE_CONFIG", |
| "VERSION_INCOMPATIBILITY", |
| "CONNECTION_PROFILE_TYPES_INCOMPATIBILITY", |
| "UNSUPPORTED_GTID_MODE", |
| "UNSUPPORTED_DEFINER" |
| ] |
| }, |
| "errorDetailMessage": { |
| "description": "Output only. A specific detailed error message, if supplied by the engine.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "errorMessage": { |
| "readOnly": true, |
| "description": "Output only. A formatted message with further details about the error and a CTA.", |
| "type": "string" |
| } |
| }, |
| "id": "MigrationJobVerificationError", |
| "description": "Error message of a verification Migration job." |
| }, |
| "CancelOperationRequest": { |
| "id": "CancelOperationRequest", |
| "type": "object", |
| "description": "The request message for Operations.CancelOperation.", |
| "properties": {} |
| }, |
| "GoogleCloudClouddmsV1beta1OperationMetadata": { |
| "id": "GoogleCloudClouddmsV1beta1OperationMetadata", |
| "description": "Represents the metadata of the long-running operation.", |
| "type": "object", |
| "properties": { |
| "requestedCancellation": { |
| "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", |
| "readOnly": true, |
| "type": "boolean" |
| }, |
| "verb": { |
| "readOnly": true, |
| "description": "Output only. Name of the verb executed by the operation.", |
| "type": "string" |
| }, |
| "target": { |
| "description": "Output only. Server-defined resource path for the target of the operation.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "statusMessage": { |
| "description": "Output only. Human-readable status of the operation, if any.", |
| "type": "string", |
| "readOnly": true |
| }, |
| "apiVersion": { |
| "type": "string", |
| "description": "Output only. API version used to start the operation.", |
| "readOnly": true |
| }, |
| "createTime": { |
| "type": "string", |
| "format": "google-datetime", |
| "readOnly": true, |
| "description": "Output only. The time the operation was created." |
| }, |
| "endTime": { |
| "format": "google-datetime", |
| "description": "Output only. The time the operation finished running.", |
| "readOnly": true, |
| "type": "string" |
| } |
| } |
| }, |
| "StopMigrationJobRequest": { |
| "id": "StopMigrationJobRequest", |
| "properties": {}, |
| "type": "object", |
| "description": "Request message for 'StopMigrationJob' request." |
| }, |
| "ListConnectionProfilesResponse": { |
| "type": "object", |
| "id": "ListConnectionProfilesResponse", |
| "properties": { |
| "unreachable": { |
| "items": { |
| "type": "string" |
| }, |
| "type": "array", |
| "description": "Locations that could not be reached." |
| }, |
| "connectionProfiles": { |
| "items": { |
| "$ref": "ConnectionProfile" |
| }, |
| "description": "The response list of connection profiles.", |
| "type": "array" |
| }, |
| "nextPageToken": { |
| "type": "string", |
| "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." |
| } |
| }, |
| "description": "Response message for 'ListConnectionProfiles' request." |
| }, |
| "MigrationJob": { |
| "type": "object", |
| "id": "MigrationJob", |
| "description": "Represents a Database Migration Service migration job object.", |
| "properties": { |
| "destinationDatabase": { |
| "description": "The database engine type and provider of the destination.", |
| "$ref": "DatabaseType" |
| }, |
| "name": { |
| "type": "string", |
| "description": "The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/instances/{instance}." |
| }, |
| "vpcPeeringConnectivity": { |
| "$ref": "VpcPeeringConnectivity", |
| "description": "The details of the VPC network that the source database is located in." |
| }, |
| "duration": { |
| "readOnly": true, |
| "type": "string", |
| "description": "Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\".", |
| "format": "google-duration" |
| }, |
| "updateTime": { |
| "description": "Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\".", |
| "type": "string", |
| "readOnly": true, |
| "format": "google-datetime" |
| }, |
| "displayName": { |
| "type": "string", |
| "description": "The migration job display name." |
| }, |
| "destination": { |
| "description": "Required. The resource name (URI) of the destination connection profile.", |
| "type": "string" |
| }, |
| "createTime": { |
| "description": "Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\".", |
| "type": "string", |
| "readOnly": true, |
| "format": "google-datetime" |
| }, |
| "staticIpConnectivity": { |
| "$ref": "StaticIpConnectivity", |
| "description": "static ip connectivity data (default, no additional details needed)." |
| }, |
| "labels": { |
| "type": "object", |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "description": "The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of \"key\": \"value\" pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`." |
| }, |
| "error": { |
| "$ref": "Status", |
| "readOnly": true, |
| "description": "Output only. The error details in case of state FAILED." |
| }, |
| "phase": { |
| "description": "Output only. The current migration job phase.", |
| "enumDescriptions": [ |
| "The phase of the migration job is unknown.", |
| "The migration job is in the full dump phase.", |
| "The migration job is CDC phase.", |
| "The migration job is running the promote phase.", |
| "Only RDS flow - waiting for source writes to stop", |
| "Only RDS flow - the sources writes stopped, waiting for dump to begin" |
| ], |
| "readOnly": true, |
| "enum": [ |
| "PHASE_UNSPECIFIED", |
| "FULL_DUMP", |
| "CDC", |
| "PROMOTE_IN_PROGRESS", |
| "WAITING_FOR_SOURCE_WRITES_TO_STOP", |
| "PREPARING_THE_DUMP" |
| ], |
| "type": "string" |
| }, |
| "type": { |
| "type": "string", |
| "enumDescriptions": [ |
| "The type of the migration job is unknown.", |
| "The migration job is a one time migration.", |
| "The migration job is a continuous migration." |
| ], |
| "enum": [ |
| "TYPE_UNSPECIFIED", |
| "ONE_TIME", |
| "CONTINUOUS" |
| ], |
| "description": "Required. The migration job type." |
| }, |
| "source": { |
| "type": "string", |
| "description": "Required. The resource name (URI) of the source connection profile." |
| }, |
| "reverseSshConnectivity": { |
| "$ref": "ReverseSshConnectivity", |
| "description": "The details needed to communicate to the source over Reverse SSH tunnel connectivity." |
| }, |
| "endTime": { |
| "description": "Output only. If the migration job is completed, the time when it was completed.", |
| "type": "string", |
| "format": "google-datetime", |
| "readOnly": true |
| }, |
| "sourceDatabase": { |
| "description": "The database engine type and provider of the source.", |
| "$ref": "DatabaseType" |
| }, |
| "state": { |
| "description": "The current migration job state.", |
| "type": "string", |
| "enum": [ |
| "STATE_UNSPECIFIED", |
| "MAINTENANCE", |
| "DRAFT", |
| "CREATING", |
| "NOT_STARTED", |
| "RUNNING", |
| "FAILED", |
| "COMPLETED", |
| "DELETING", |
| "STOPPING", |
| "STOPPED", |
| "DELETED", |
| "UPDATING", |
| "STARTING", |
| "RESTARTING", |
| "RESUMING" |
| ], |
| "enumDescriptions": [ |
| "The state of the migration job is unknown.", |
| "The migration job is down for maintenance.", |
| "The migration job is in draft mode and no resources are created.", |
| "The migration job is being created.", |
| "The migration job is created, not started and is fully editable.", |
| "The migration job is running.", |
| "The migration job failed.", |
| "The migration job has been completed.", |
| "The migration job is being deleted.", |
| "The migration job is being stopped.", |
| "The migration job is currently stopped.", |
| "The migration job has been deleted.", |
| "The migration job is being updated.", |
| "The migration job is starting.", |
| "The migration job is restarting.", |
| "The migration job is resuming." |
| ] |
| }, |
| "dumpPath": { |
| "description": "The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]).", |
| "type": "string" |
| } |
| } |
| }, |
| "Empty": { |
| "type": "object", |
| "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", |
| "id": "Empty", |
| "properties": {} |
| } |
| }, |
| "batchPath": "batch", |
| "title": "Database Migration API", |
| "ownerName": "Google", |
| "servicePath": "", |
| "rootUrl": "https://datamigration.googleapis.com/", |
| "mtlsRootUrl": "https://datamigration.mtls.googleapis.com/", |
| "id": "datamigration:v1beta1", |
| "protocol": "rest", |
| "revision": "20201028", |
| "basePath": "", |
| "description": "Manage Cloud Database Migration Service resources on Google Cloud Platform.", |
| "ownerDomain": "google.com", |
| "canonicalName": "Cloud Database Migration Service", |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "version_module": true, |
| "documentationLink": "https://cloud.google.com/datamigration/", |
| "resources": { |
| "projects": { |
| "resources": { |
| "locations": { |
| "methods": { |
| "get": { |
| "response": { |
| "$ref": "Location" |
| }, |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}", |
| "httpMethod": "GET", |
| "description": "Gets information about a location.", |
| "parameters": { |
| "name": { |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "type": "string", |
| "location": "path", |
| "required": true, |
| "description": "Resource name for the location." |
| } |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "id": "datamigration.projects.locations.get", |
| "path": "v1beta1/{+name}", |
| "parameterOrder": [ |
| "name" |
| ] |
| }, |
| "list": { |
| "flatPath": "v1beta1/projects/{projectsId}/locations", |
| "description": "Lists information about the supported locations for this service.", |
| "httpMethod": "GET", |
| "id": "datamigration.projects.locations.list", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "response": { |
| "$ref": "ListLocationsResponse" |
| }, |
| "parameters": { |
| "filter": { |
| "description": "The standard list filter.", |
| "type": "string", |
| "location": "query" |
| }, |
| "pageSize": { |
| "format": "int32", |
| "type": "integer", |
| "location": "query", |
| "description": "The standard list page size." |
| }, |
| "pageToken": { |
| "type": "string", |
| "location": "query", |
| "description": "The standard list page token." |
| }, |
| "name": { |
| "required": true, |
| "location": "path", |
| "pattern": "^projects/[^/]+$", |
| "description": "The resource that owns the locations collection, if applicable.", |
| "type": "string" |
| } |
| }, |
| "parameterOrder": [ |
| "name" |
| ], |
| "path": "v1beta1/{+name}/locations" |
| } |
| }, |
| "resources": { |
| "migrationJobs": { |
| "methods": { |
| "stop": { |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "description": "Stops a running migration job.", |
| "path": "v1beta1/{+name}:stop", |
| "id": "datamigration.projects.locations.migrationJobs.stop", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:stop", |
| "parameterOrder": [ |
| "name" |
| ], |
| "httpMethod": "POST", |
| "request": { |
| "$ref": "StopMigrationJobRequest" |
| }, |
| "parameters": { |
| "name": { |
| "required": true, |
| "location": "path", |
| "type": "string", |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "description": "Name of the migration job resource to stop." |
| } |
| }, |
| "response": { |
| "$ref": "Operation" |
| } |
| }, |
| "create": { |
| "path": "v1beta1/{+parent}/migrationJobs", |
| "request": { |
| "$ref": "MigrationJob" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "response": { |
| "$ref": "Operation" |
| }, |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs", |
| "id": "datamigration.projects.locations.migrationJobs.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "description": "Creates a new migration job in a given project and location.", |
| "httpMethod": "POST", |
| "parameters": { |
| "requestId": { |
| "type": "string", |
| "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", |
| "location": "query" |
| }, |
| "parent": { |
| "required": true, |
| "type": "string", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "description": "Required. The parent, which owns this collection of migration jobs." |
| }, |
| "migrationJobId": { |
| "type": "string", |
| "description": "Required. The ID of the instance to create.", |
| "location": "query" |
| } |
| } |
| }, |
| "patch": { |
| "response": { |
| "$ref": "Operation" |
| }, |
| "request": { |
| "$ref": "MigrationJob" |
| }, |
| "parameters": { |
| "requestId": { |
| "location": "query", |
| "type": "string", |
| "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters." |
| }, |
| "updateMask": { |
| "format": "google-fieldmask", |
| "description": "Required. Field mask is used to specify the fields to be overwritten in the migration job resource by the update.", |
| "type": "string", |
| "location": "query" |
| }, |
| "name": { |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "description": "The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/instances/{instance}.", |
| "type": "string", |
| "location": "path", |
| "required": true |
| } |
| }, |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}", |
| "httpMethod": "PATCH", |
| "id": "datamigration.projects.locations.migrationJobs.patch", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "path": "v1beta1/{+name}", |
| "description": "Updates the parameters of a single migration job.", |
| "parameterOrder": [ |
| "name" |
| ] |
| }, |
| "start": { |
| "response": { |
| "$ref": "Operation" |
| }, |
| "parameters": { |
| "name": { |
| "required": true, |
| "type": "string", |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "location": "path", |
| "description": "Name of the migration job resource to start." |
| } |
| }, |
| "httpMethod": "POST", |
| "description": "Start an already created migration job.", |
| "parameterOrder": [ |
| "name" |
| ], |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "path": "v1beta1/{+name}:start", |
| "id": "datamigration.projects.locations.migrationJobs.start", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:start", |
| "request": { |
| "$ref": "StartMigrationJobRequest" |
| } |
| }, |
| "setIamPolicy": { |
| "parameters": { |
| "resource": { |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "required": true, |
| "type": "string", |
| "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", |
| "location": "path" |
| } |
| }, |
| "parameterOrder": [ |
| "resource" |
| ], |
| "path": "v1beta1/{+resource}:setIamPolicy", |
| "id": "datamigration.projects.locations.migrationJobs.setIamPolicy", |
| "httpMethod": "POST", |
| "response": { |
| "$ref": "Policy" |
| }, |
| "request": { |
| "$ref": "SetIamPolicyRequest" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:setIamPolicy" |
| }, |
| "getIamPolicy": { |
| "id": "datamigration.projects.locations.migrationJobs.getIamPolicy", |
| "httpMethod": "GET", |
| "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:getIamPolicy", |
| "path": "v1beta1/{+resource}:getIamPolicy", |
| "parameterOrder": [ |
| "resource" |
| ], |
| "parameters": { |
| "options.requestedPolicyVersion": { |
| "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", |
| "location": "query", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "resource": { |
| "location": "path", |
| "required": true, |
| "type": "string", |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field." |
| } |
| }, |
| "response": { |
| "$ref": "Policy" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "resume": { |
| "parameterOrder": [ |
| "name" |
| ], |
| "response": { |
| "$ref": "Operation" |
| }, |
| "parameters": { |
| "name": { |
| "type": "string", |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "description": "Name of the migration job resource to resume.", |
| "location": "path" |
| } |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "id": "datamigration.projects.locations.migrationJobs.resume", |
| "request": { |
| "$ref": "ResumeMigrationJobRequest" |
| }, |
| "description": "Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:resume", |
| "httpMethod": "POST", |
| "path": "v1beta1/{+name}:resume" |
| }, |
| "promote": { |
| "description": "Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "description": "Name of the migration job resource to promote.", |
| "type": "string", |
| "location": "path" |
| } |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "request": { |
| "$ref": "PromoteMigrationJobRequest" |
| }, |
| "httpMethod": "POST", |
| "id": "datamigration.projects.locations.migrationJobs.promote", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:promote", |
| "path": "v1beta1/{+name}:promote" |
| }, |
| "testIamPermissions": { |
| "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", |
| "parameterOrder": [ |
| "resource" |
| ], |
| "parameters": { |
| "resource": { |
| "location": "path", |
| "type": "string", |
| "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$" |
| } |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "id": "datamigration.projects.locations.migrationJobs.testIamPermissions", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:testIamPermissions", |
| "request": { |
| "$ref": "TestIamPermissionsRequest" |
| }, |
| "response": { |
| "$ref": "TestIamPermissionsResponse" |
| }, |
| "httpMethod": "POST", |
| "path": "v1beta1/{+resource}:testIamPermissions" |
| }, |
| "get": { |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}", |
| "description": "Gets details of a single migration job.", |
| "httpMethod": "GET", |
| "id": "datamigration.projects.locations.migrationJobs.get", |
| "parameters": { |
| "name": { |
| "type": "string", |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "location": "path", |
| "description": "Required. Name of the migration job resource to get." |
| } |
| }, |
| "parameterOrder": [ |
| "name" |
| ], |
| "response": { |
| "$ref": "MigrationJob" |
| }, |
| "path": "v1beta1/{+name}", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "verify": { |
| "description": "Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.", |
| "path": "v1beta1/{+name}:verify", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:verify", |
| "parameters": { |
| "name": { |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "description": "Name of the migration job resource to verify.", |
| "location": "path", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "response": { |
| "$ref": "Operation" |
| }, |
| "request": { |
| "$ref": "VerifyMigrationJobRequest" |
| }, |
| "parameterOrder": [ |
| "name" |
| ], |
| "id": "datamigration.projects.locations.migrationJobs.verify", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "httpMethod": "POST" |
| }, |
| "list": { |
| "parameterOrder": [ |
| "parent" |
| ], |
| "id": "datamigration.projects.locations.migrationJobs.list", |
| "parameters": { |
| "orderBy": { |
| "location": "query", |
| "type": "string", |
| "description": "Sort the results based on the migration job name. Valid values are: \"name\", \"name asc\", and \"name desc\"." |
| }, |
| "filter": { |
| "description": "A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c. For example, list migration jobs created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **reverseSshConnectivity.vmIp = \"1.2.3.4\"** to select all migration jobs connecting through the specific SSH tunnel bastion.", |
| "location": "query", |
| "type": "string" |
| }, |
| "pageToken": { |
| "type": "string", |
| "description": "The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.", |
| "location": "query" |
| }, |
| "pageSize": { |
| "location": "query", |
| "type": "integer", |
| "description": "The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", |
| "format": "int32" |
| }, |
| "parent": { |
| "type": "string", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true, |
| "description": "Required. The parent, which owns this collection of migrationJobs.", |
| "location": "path" |
| } |
| }, |
| "path": "v1beta1/{+parent}/migrationJobs", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "response": { |
| "$ref": "ListMigrationJobsResponse" |
| }, |
| "description": "Lists migration jobs in a given project and location.", |
| "httpMethod": "GET", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs" |
| }, |
| "generateSshScript": { |
| "httpMethod": "POST", |
| "request": { |
| "$ref": "GenerateSshScriptRequest" |
| }, |
| "path": "v1beta1/{+migrationJob}:generateSshScript", |
| "parameters": { |
| "migrationJob": { |
| "description": "Name of the migration job resource to generate the SSH script.", |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "type": "string", |
| "location": "path" |
| } |
| }, |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:generateSshScript", |
| "id": "datamigration.projects.locations.migrationJobs.generateSshScript", |
| "description": "Generate a SSH configuration script to configure the reverse SSH connectivity.", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "response": { |
| "$ref": "SshScript" |
| }, |
| "parameterOrder": [ |
| "migrationJob" |
| ] |
| }, |
| "restart": { |
| "description": "Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.", |
| "id": "datamigration.projects.locations.migrationJobs.restart", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "path": "v1beta1/{+name}:restart", |
| "httpMethod": "POST", |
| "request": { |
| "$ref": "RestartMigrationJobRequest" |
| }, |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}:restart", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "required": true, |
| "location": "path", |
| "description": "Name of the migration job resource to restart.", |
| "type": "string" |
| } |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "path": "v1beta1/{+name}", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "description": "Deletes a single migration job.", |
| "id": "datamigration.projects.locations.migrationJobs.delete", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}", |
| "parameters": { |
| "name": { |
| "location": "path", |
| "required": true, |
| "type": "string", |
| "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", |
| "description": "Required. Name of the migration job resource to delete." |
| }, |
| "force": { |
| "description": "The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted.", |
| "type": "boolean", |
| "location": "query" |
| }, |
| "requestId": { |
| "location": "query", |
| "type": "string", |
| "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters." |
| } |
| }, |
| "parameterOrder": [ |
| "name" |
| ], |
| "httpMethod": "DELETE" |
| } |
| } |
| }, |
| "operations": { |
| "methods": { |
| "cancel": { |
| "id": "datamigration.projects.locations.operations.cancel", |
| "parameters": { |
| "name": { |
| "description": "The name of the operation resource to be cancelled.", |
| "type": "string", |
| "required": true, |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" |
| } |
| }, |
| "request": { |
| "$ref": "CancelOperationRequest" |
| }, |
| "parameterOrder": [ |
| "name" |
| ], |
| "response": { |
| "$ref": "Empty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "httpMethod": "POST", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", |
| "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", |
| "path": "v1beta1/{+name}:cancel" |
| }, |
| "get": { |
| "path": "v1beta1/{+name}", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "id": "datamigration.projects.locations.operations.get", |
| "parameters": { |
| "name": { |
| "type": "string", |
| "location": "path", |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", |
| "description": "The name of the operation resource." |
| } |
| }, |
| "response": { |
| "$ref": "Operation" |
| }, |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", |
| "httpMethod": "GET", |
| "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", |
| "parameterOrder": [ |
| "name" |
| ] |
| }, |
| "delete": { |
| "id": "datamigration.projects.locations.operations.delete", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "parameterOrder": [ |
| "name" |
| ], |
| "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", |
| "path": "v1beta1/{+name}", |
| "httpMethod": "DELETE", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", |
| "response": { |
| "$ref": "Empty" |
| }, |
| "parameters": { |
| "name": { |
| "required": true, |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", |
| "description": "The name of the operation resource to be deleted.", |
| "type": "string" |
| } |
| } |
| }, |
| "list": { |
| "parameterOrder": [ |
| "name" |
| ], |
| "httpMethod": "GET", |
| "path": "v1beta1/{+name}/operations", |
| "id": "datamigration.projects.locations.operations.list", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", |
| "response": { |
| "$ref": "ListOperationsResponse" |
| }, |
| "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", |
| "parameters": { |
| "name": { |
| "required": true, |
| "description": "The name of the operation's parent resource.", |
| "type": "string", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "location": "path" |
| }, |
| "filter": { |
| "description": "The standard list filter.", |
| "type": "string", |
| "location": "query" |
| }, |
| "pageSize": { |
| "description": "The standard list page size.", |
| "format": "int32", |
| "type": "integer", |
| "location": "query" |
| }, |
| "pageToken": { |
| "type": "string", |
| "description": "The standard list page token.", |
| "location": "query" |
| } |
| } |
| } |
| } |
| }, |
| "connectionProfiles": { |
| "methods": { |
| "setIamPolicy": { |
| "path": "v1beta1/{+resource}:setIamPolicy", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}:setIamPolicy", |
| "request": { |
| "$ref": "SetIamPolicyRequest" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", |
| "parameterOrder": [ |
| "resource" |
| ], |
| "parameters": { |
| "resource": { |
| "location": "path", |
| "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", |
| "type": "string", |
| "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", |
| "required": true |
| } |
| }, |
| "id": "datamigration.projects.locations.connectionProfiles.setIamPolicy", |
| "response": { |
| "$ref": "Policy" |
| }, |
| "httpMethod": "POST" |
| }, |
| "patch": { |
| "path": "v1beta1/{+name}", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "parameters": { |
| "name": { |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", |
| "location": "path", |
| "description": "The name of this connection profile resource in the form of projects/{project}/locations/{location}/instances/{instance}.", |
| "type": "string" |
| }, |
| "updateMask": { |
| "location": "query", |
| "description": "Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update.", |
| "format": "google-fieldmask", |
| "type": "string" |
| }, |
| "requestId": { |
| "location": "query", |
| "type": "string", |
| "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters." |
| } |
| }, |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}", |
| "request": { |
| "$ref": "ConnectionProfile" |
| }, |
| "id": "datamigration.projects.locations.connectionProfiles.patch", |
| "httpMethod": "PATCH", |
| "parameterOrder": [ |
| "name" |
| ], |
| "response": { |
| "$ref": "Operation" |
| }, |
| "description": "Update the configuration of a single connection profile." |
| }, |
| "testIamPermissions": { |
| "id": "datamigration.projects.locations.connectionProfiles.testIamPermissions", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}:testIamPermissions", |
| "path": "v1beta1/{+resource}:testIamPermissions", |
| "response": { |
| "$ref": "TestIamPermissionsResponse" |
| }, |
| "request": { |
| "$ref": "TestIamPermissionsRequest" |
| }, |
| "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", |
| "httpMethod": "POST", |
| "parameterOrder": [ |
| "resource" |
| ], |
| "parameters": { |
| "resource": { |
| "type": "string", |
| "location": "path", |
| "required": true, |
| "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", |
| "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$" |
| } |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "parameterOrder": [ |
| "name" |
| ], |
| "response": { |
| "$ref": "ConnectionProfile" |
| }, |
| "httpMethod": "GET", |
| "id": "datamigration.projects.locations.connectionProfiles.get", |
| "description": "Gets details of a single connection profile.", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "path": "v1beta1/{+name}", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}", |
| "parameters": { |
| "name": { |
| "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", |
| "description": "Required. Name of the connection profile resource to get.", |
| "required": true, |
| "type": "string", |
| "location": "path" |
| } |
| } |
| }, |
| "getIamPolicy": { |
| "path": "v1beta1/{+resource}:getIamPolicy", |
| "parameters": { |
| "options.requestedPolicyVersion": { |
| "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", |
| "type": "integer", |
| "location": "query", |
| "format": "int32" |
| }, |
| "resource": { |
| "location": "path", |
| "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", |
| "type": "string", |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$" |
| } |
| }, |
| "parameterOrder": [ |
| "resource" |
| ], |
| "httpMethod": "GET", |
| "id": "datamigration.projects.locations.connectionProfiles.getIamPolicy", |
| "response": { |
| "$ref": "Policy" |
| }, |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}:getIamPolicy", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set." |
| }, |
| "list": { |
| "id": "datamigration.projects.locations.connectionProfiles.list", |
| "parameters": { |
| "pageToken": { |
| "type": "string", |
| "description": "A page token, received from a previous `ListConnectionProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectionProfiles` must match the call that provided the page token.", |
| "location": "query" |
| }, |
| "pageSize": { |
| "type": "integer", |
| "format": "int32", |
| "description": "The maximum number of connection profiles to return. The service may return fewer than this value. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", |
| "location": "query" |
| }, |
| "orderBy": { |
| "type": "string", |
| "description": "the order by fields for the result.", |
| "location": "query" |
| }, |
| "parent": { |
| "type": "string", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "location": "path", |
| "required": true, |
| "description": "Required. The parent, which owns this collection of connection profiles." |
| }, |
| "filter": { |
| "type": "string", |
| "description": "A filter expression that filters connection profiles listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, \u003e, or \u003c. For example, list connection profiles created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can also filter nested fields. For example, you could specify **mySql.username = %lt;my_username%gt;** to list all connection profiles configured to connect with a specific username.", |
| "location": "query" |
| } |
| }, |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connectionProfiles", |
| "response": { |
| "$ref": "ListConnectionProfilesResponse" |
| }, |
| "path": "v1beta1/{+parent}/connectionProfiles", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "description": "Retrieve a list of all connection profiles in a given project and location.", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "httpMethod": "GET" |
| }, |
| "delete": { |
| "parameterOrder": [ |
| "name" |
| ], |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "response": { |
| "$ref": "Operation" |
| }, |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}", |
| "parameters": { |
| "requestId": { |
| "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", |
| "type": "string", |
| "location": "query" |
| }, |
| "force": { |
| "description": "In case of force delete, the CloudSQL replica database is also deleted (only for CloudSQL connection profile).", |
| "type": "boolean", |
| "location": "query" |
| }, |
| "name": { |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", |
| "location": "path", |
| "description": "Required. Name of the connection profile resource to delete.", |
| "type": "string" |
| } |
| }, |
| "description": "Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.", |
| "id": "datamigration.projects.locations.connectionProfiles.delete", |
| "httpMethod": "DELETE", |
| "path": "v1beta1/{+name}" |
| }, |
| "create": { |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "parameters": { |
| "connectionProfileId": { |
| "description": "Required. The connection profile identifier.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true, |
| "description": "Required. The parent, which owns this collection of connection profiles.", |
| "location": "path", |
| "type": "string" |
| }, |
| "requestId": { |
| "location": "query", |
| "type": "string", |
| "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters." |
| } |
| }, |
| "path": "v1beta1/{+parent}/connectionProfiles", |
| "request": { |
| "$ref": "ConnectionProfile" |
| }, |
| "parameterOrder": [ |
| "parent" |
| ], |
| "id": "datamigration.projects.locations.connectionProfiles.create", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "description": "Creates a new connection profile in a given project and location.", |
| "httpMethod": "POST", |
| "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connectionProfiles" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "discoveryVersion": "v1", |
| "baseUrl": "https://datamigration.googleapis.com/", |
| "version": "v1beta1" |
| } |
