{ "baseUrl": "https://oracledatabase.googleapis.com/", "version_module": true, "protocol": "rest", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "id": "oracledatabase.projects.locations.list", "path": "v1/{+name}/locations", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version." }, "get": { "id": "oracledatabase.projects.locations.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "list": { "id": "oracledatabase.projects.locations.operations.list", "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "oracledatabase.projects.locations.operations.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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." }, "delete": { "id": "oracledatabase.projects.locations.operations.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`." }, "cancel": { "id": "oracledatabase.projects.locations.operations.cancel", "path": "v1/{+name}:cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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`." } } }, "cloudExadataInfrastructures": { "methods": { "list": { "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.list", "path": "v1/{+parent}/cloudExadataInfrastructures", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListCloudExadataInfrastructuresResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Exadata Infrastructures in a given project and location." }, "get": { "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.", "pattern": "^projects/[^/]+/locations/[^/]+/cloudExadataInfrastructures/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "CloudExadataInfrastructure" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Exadata Infrastructure." }, "create": { "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.create", "path": "v1/{+parent}/cloudExadataInfrastructures", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "cloudExadataInfrastructureId": { "description": "Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "CloudExadataInfrastructure" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new Exadata Infrastructure in a given project and location." }, "delete": { "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.", "pattern": "^projects/[^/]+/locations/[^/]+/cloudExadataInfrastructures/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "force": { "description": "Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Exadata Infrastructure." }, "configureExascale": { "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.configureExascale", "path": "v1/{+name}:configureExascale", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}:configureExascale", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.", "pattern": "^projects/[^/]+/locations/[^/]+/cloudExadataInfrastructures/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "ConfigureExascaleCloudExadataInfrastructureRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Configures Exascale for a single Exadata Infrastructure." } }, "resources": { "dbServers": { "methods": { "list": { "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.dbServers.list", "path": "v1/{+parent}/dbServers", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}/dbServers", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for database server in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloudExadataInfrastructure}.", "pattern": "^projects/[^/]+/locations/[^/]+/cloudExadataInfrastructures/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDbServersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the database servers of an Exadata Infrastructure instance." } } } } }, "cloudVmClusters": { "methods": { "list": { "id": "oracledatabase.projects.locations.cloudVmClusters.list", "path": "v1/{+parent}/cloudVmClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The name of the parent in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying the page of results the server returns.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListCloudVmClustersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the VM Clusters in a given project and location." }, "get": { "id": "oracledatabase.projects.locations.cloudVmClusters.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters/{cloudVmClustersId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.", "pattern": "^projects/[^/]+/locations/[^/]+/cloudVmClusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "CloudVmCluster" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single VM Cluster." }, "create": { "id": "oracledatabase.projects.locations.cloudVmClusters.create", "path": "v1/{+parent}/cloudVmClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the parent in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "cloudVmClusterId": { "description": "Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "CloudVmCluster" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new VM Cluster in a given project and location." }, "delete": { "id": "oracledatabase.projects.locations.cloudVmClusters.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters/{cloudVmClustersId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.", "pattern": "^projects/[^/]+/locations/[^/]+/cloudVmClusters/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "force": { "description": "Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single VM Cluster." } }, "resources": { "dbNodes": { "methods": { "list": { "id": "oracledatabase.projects.locations.cloudVmClusters.dbNodes.list", "path": "v1/{+parent}/dbNodes", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters/{cloudVmClustersId}/dbNodes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}. .", "pattern": "^projects/[^/]+/locations/[^/]+/cloudVmClusters/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the node should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDbNodesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the database nodes of a VM Cluster." } } } } }, "entitlements": { "methods": { "list": { "id": "oracledatabase.projects.locations.entitlements.list", "path": "v1/{+parent}/entitlements", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for the entitlement in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListEntitlementsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the entitlements in a given project." } } }, "giVersions": { "methods": { "list": { "id": "oracledatabase.projects.locations.giVersions.list", "path": "v1/{+parent}/giVersions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/giVersions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape=\"{shape}\"`.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGiVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location." } }, "resources": { "minorVersions": { "methods": { "list": { "id": "oracledatabase.projects.locations.giVersions.minorVersions.list", "path": "v1/{+parent}/minorVersions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/giVersions/{giVersionsId}/minorVersions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for the MinorVersion resource with the format: projects/{project}/locations/{location}/giVersions/{gi_version}", "pattern": "^projects/[^/]+/locations/[^/]+/giVersions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family=\"{shapeFamily}\" AND gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\"`.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListMinorVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the valid minor versions for the given project, location, gi version and shape family." } } } } }, "dbSystemShapes": { "methods": { "list": { "id": "oracledatabase.projects.locations.dbSystemShapes.list", "path": "v1/{+parent}/dbSystemShapes", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystemShapes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for Database System Shapes in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: `gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\"`.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDbSystemShapesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the database system shapes available for the project and location." } } }, "autonomousDatabases": { "methods": { "list": { "id": "oracledatabase.projects.locations.autonomousDatabases.list", "path": "v1/{+parent}/autonomousDatabases", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListAutonomousDatabasesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the Autonomous Databases in a given project and location." }, "get": { "id": "oracledatabase.projects.locations.autonomousDatabases.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "AutonomousDatabase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the details of a single Autonomous Database." }, "create": { "id": "oracledatabase.projects.locations.autonomousDatabases.create", "path": "v1/{+parent}/autonomousDatabases", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the parent in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "autonomousDatabaseId": { "description": "Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "AutonomousDatabase" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new Autonomous Database in a given project and location." }, "patch": { "id": "oracledatabase.projects.locations.autonomousDatabases.patch", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "AutonomousDatabase" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single Autonomous Database." }, "delete": { "id": "oracledatabase.projects.locations.autonomousDatabases.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Autonomous Database." }, "restore": { "id": "oracledatabase.projects.locations.autonomousDatabases.restore", "path": "v1/{+name}:restore", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:restore", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "RestoreAutonomousDatabaseRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Restores a single Autonomous Database." }, "generateWallet": { "id": "oracledatabase.projects.locations.autonomousDatabases.generateWallet", "path": "v1/{+name}:generateWallet", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:generateWallet", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GenerateAutonomousDatabaseWalletRequest" }, "response": { "$ref": "GenerateAutonomousDatabaseWalletResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Generates a wallet for an Autonomous Database." }, "stop": { "id": "oracledatabase.projects.locations.autonomousDatabases.stop", "path": "v1/{+name}:stop", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:stop", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "StopAutonomousDatabaseRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Stops an Autonomous Database." }, "start": { "id": "oracledatabase.projects.locations.autonomousDatabases.start", "path": "v1/{+name}:start", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:start", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "StartAutonomousDatabaseRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts an Autonomous Database." }, "restart": { "id": "oracledatabase.projects.locations.autonomousDatabases.restart", "path": "v1/{+name}:restart", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:restart", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "RestartAutonomousDatabaseRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Restarts an Autonomous Database." }, "switchover": { "id": "oracledatabase.projects.locations.autonomousDatabases.switchover", "path": "v1/{+name}:switchover", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:switchover", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "SwitchoverAutonomousDatabaseRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Initiates a switchover of specified autonomous database to the associated peer database." }, "failover": { "id": "oracledatabase.projects.locations.autonomousDatabases.failover", "path": "v1/{+name}:failover", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:failover", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "FailoverAutonomousDatabaseRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Initiates a failover to target autonomous database from the associated primary database." } } }, "autonomousDbVersions": { "methods": { "list": { "id": "oracledatabase.projects.locations.autonomousDbVersions.list", "path": "v1/{+parent}/autonomousDbVersions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDbVersions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListAutonomousDbVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the available Autonomous Database versions for a project and location." } } }, "autonomousDatabaseCharacterSets": { "methods": { "list": { "id": "oracledatabase.projects.locations.autonomousDatabaseCharacterSets.list", "path": "v1/{+parent}/autonomousDatabaseCharacterSets", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseCharacterSets", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type=\"{characterSetType}\"`. Accepted values include `DATABASE` and `NATIONAL`.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListAutonomousDatabaseCharacterSetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Autonomous Database Character Sets in a given project and location." } } }, "autonomousDatabaseBackups": { "methods": { "list": { "id": "oracledatabase.projects.locations.autonomousDatabaseBackups.list", "path": "v1/{+parent}/autonomousDatabaseBackups", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseBackups", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. Only the **autonomous_database_id** field is supported in the following format: `autonomous_database_id=\"{autonomous_database_id}\"`. The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListAutonomousDatabaseBackupsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the long-term and automatic backups of an Autonomous Database." } } }, "odbNetworks": { "methods": { "list": { "id": "oracledatabase.projects.locations.odbNetworks.list", "path": "v1/{+parent}/odbNetworks", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListOdbNetworksResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the ODB Networks in a given project and location." }, "get": { "id": "oracledatabase.projects.locations.odbNetworks.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "OdbNetwork" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single ODB Network." }, "create": { "id": "oracledatabase.projects.locations.odbNetworks.create", "path": "v1/{+parent}/odbNetworks", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "odbNetworkId": { "description": "Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "OdbNetwork" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new ODB Network in a given project and location." }, "delete": { "id": "oracledatabase.projects.locations.odbNetworks.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single ODB Network." } }, "resources": { "odbSubnets": { "methods": { "list": { "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.list", "path": "v1/{+parent}/odbSubnets", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListOdbSubnetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the ODB Subnets in a given ODB Network." }, "get": { "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "OdbSubnet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single ODB Subnet." }, "create": { "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.create", "path": "v1/{+parent}/odbSubnets", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", "location": "path", "required": true, "type": "string" }, "odbSubnetId": { "description": "Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "OdbSubnet" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new ODB Subnet in a given ODB Network." }, "delete": { "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single ODB Subnet." } } } } }, "exadbVmClusters": { "methods": { "list": { "id": "oracledatabase.projects.locations.exadbVmClusters.list", "path": "v1/{+parent}/exadbVmClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for ExadbVmClusters in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListExadbVmClustersResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the Exadb (Exascale) VM Clusters for the given project and location." }, "get": { "id": "oracledatabase.projects.locations.exadbVmClusters.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.", "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ExadbVmCluster" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Exadb (Exascale) VM Cluster." }, "create": { "id": "oracledatabase.projects.locations.exadbVmClusters.create", "path": "v1/{+parent}/exadbVmClusters", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The value for parent of the ExadbVmCluster in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "exadbVmClusterId": { "description": "Required. The ID of the ExadbVmCluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "ExadbVmCluster" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new Exadb (Exascale) VM Cluster resource." }, "delete": { "id": "oracledatabase.projects.locations.exadbVmClusters.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.", "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Exadb (Exascale) VM Cluster." }, "patch": { "id": "oracledatabase.projects.locations.exadbVmClusters.patch", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}", "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "ExadbVmCluster" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count." }, "removeVirtualMachine": { "id": "oracledatabase.projects.locations.exadbVmClusters.removeVirtualMachine", "path": "v1/{+name}:removeVirtualMachine", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}:removeVirtualMachine", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.", "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "RemoveVirtualMachineExadbVmClusterRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Removes virtual machines from an existing exadb vm cluster." } }, "resources": { "dbNodes": { "methods": { "list": { "id": "oracledatabase.projects.locations.exadbVmClusters.dbNodes.list", "path": "v1/{+parent}/dbNodes", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}/dbNodes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}. .", "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the node should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDbNodesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists the database nodes of a VM Cluster." } } } } }, "exascaleDbStorageVaults": { "methods": { "list": { "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.list", "path": "v1/{+parent}/exascaleDbStorageVaults", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListExascaleDbStorageVaultsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the ExascaleDB Storage Vaults for the given project and location." }, "get": { "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults/{exascaleDbStorageVaultsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}.", "pattern": "^projects/[^/]+/locations/[^/]+/exascaleDbStorageVaults/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ExascaleDbStorageVault" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single ExascaleDB Storage Vault." }, "create": { "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.create", "path": "v1/{+parent}/exascaleDbStorageVaults", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "exascaleDbStorageVaultId": { "description": "Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "ExascaleDbStorageVault" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new ExascaleDB Storage Vault resource." }, "delete": { "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults/{exascaleDbStorageVaultsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}.", "pattern": "^projects/[^/]+/locations/[^/]+/exascaleDbStorageVaults/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single ExascaleDB Storage Vault." } } }, "dbSystemInitialStorageSizes": { "methods": { "list": { "id": "oracledatabase.projects.locations.dbSystemInitialStorageSizes.list", "path": "v1/{+parent}/dbSystemInitialStorageSizes", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystemInitialStorageSizes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbSystemInitialStorageSizes will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDbSystemInitialStorageSizesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the DbSystemInitialStorageSizes for the given project and location." } } }, "databases": { "methods": { "list": { "id": "oracledatabase.projects.locations.databases.list", "path": "v1/{+parent}/databases", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/databases", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource name in the following format: projects/{project}/locations/{region}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: `dbSystem=\"projects/{project}/locations/{location}/dbSystems/{dbSystemId}\"`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDatabasesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the Databases for the given project, location and DbSystem." }, "get": { "id": "oracledatabase.projects.locations.databases.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/databases/{databasesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}", "pattern": "^projects/[^/]+/locations/[^/]+/databases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Database" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Database." } } }, "pluggableDatabases": { "methods": { "list": { "id": "oracledatabase.projects.locations.pluggableDatabases.list", "path": "v1/{+parent}/pluggableDatabases", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListPluggableDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluggableDatabases` must match the call that provided the page token.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: `database=\"projects/{project}/locations/{location}/databases/{database}\"`", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListPluggableDatabasesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the PluggableDatabases for the given project, location and Container Database." }, "get": { "id": "oracledatabase.projects.locations.pluggableDatabases.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases/{pluggableDatabasesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}", "pattern": "^projects/[^/]+/locations/[^/]+/pluggableDatabases/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "PluggableDatabase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single PluggableDatabase." } } }, "dbSystems": { "methods": { "list": { "id": "oracledatabase.projects.locations.dbSystems.list", "path": "v1/{+parent}/dbSystems", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for DbSystems in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 DbSystems will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDbSystemsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the DbSystems for the given project and location." }, "get": { "id": "oracledatabase.projects.locations.dbSystems.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems/{dbSystemsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}.", "pattern": "^projects/[^/]+/locations/[^/]+/dbSystems/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "DbSystem" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single DbSystem." }, "create": { "id": "oracledatabase.projects.locations.dbSystems.create", "path": "v1/{+parent}/dbSystems", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The value for parent of the DbSystem in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "dbSystemId": { "description": "Required. The ID of the DbSystem to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "DbSystem" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new DbSystem in a given project and location." }, "delete": { "id": "oracledatabase.projects.locations.dbSystems.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems/{dbSystemsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}.", "pattern": "^projects/[^/]+/locations/[^/]+/dbSystems/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single DbSystem." } } }, "goldengateDeployments": { "methods": { "list": { "id": "oracledatabase.projects.locations.goldengateDeployments.list", "path": "v1/{+parent}/goldengateDeployments", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for GoldengateDeployments in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 GoldengateDeployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous ListGoldengateDeployments call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGoldengateDeploymentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the GoldengateDeployments for the given project and location." }, "get": { "id": "oracledatabase.projects.locations.goldengateDeployments.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the GoldengateDeployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.", "pattern": "^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoldengateDeployment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single GoldengateDeployment." }, "create": { "id": "oracledatabase.projects.locations.goldengateDeployments.create", "path": "v1/{+parent}/goldengateDeployments", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The value for parent of the GoldengateDeployment in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "goldengateDeploymentId": { "description": "Required. The ID of the GoldengateDeployment to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoldengateDeployment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new GoldengateDeployment in a given project and location." }, "delete": { "id": "oracledatabase.projects.locations.goldengateDeployments.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the GoldengateDeployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.", "pattern": "^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single GoldengateDeployment." }, "stop": { "id": "oracledatabase.projects.locations.goldengateDeployments.stop", "path": "v1/{+name}:stop", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}:stop", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the Goldengate Deployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.", "pattern": "^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "StopGoldengateDeploymentRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Stops a single GoldengateDeployment." }, "start": { "id": "oracledatabase.projects.locations.goldengateDeployments.start", "path": "v1/{+name}:start", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}:start", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the Goldengate Deployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.", "pattern": "^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "StartGoldengateDeploymentRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts a single GoldengateDeployment." } } }, "goldengateConnections": { "methods": { "list": { "id": "oracledatabase.projects.locations.goldengateConnections.list", "path": "v1/{+parent}/goldengateConnections", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for GoldengateConnections in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 GoldengateConnections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous ListGoldengateConnections call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGoldengateConnectionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the GoldengateConnections for the given project and location." }, "get": { "id": "oracledatabase.projects.locations.goldengateConnections.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections/{goldengateConnectionsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the GoldengateConnection in the following format: projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}.", "pattern": "^projects/[^/]+/locations/[^/]+/goldengateConnections/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoldengateConnection" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single GoldengateConnection." }, "create": { "id": "oracledatabase.projects.locations.goldengateConnections.create", "path": "v1/{+parent}/goldengateConnections", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The value for parent of the GoldengateConnection in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "goldengateConnectionId": { "description": "Required. The ID of the GoldengateConnection to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoldengateConnection" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new GoldengateConnection in a given project and location." }, "delete": { "id": "oracledatabase.projects.locations.goldengateConnections.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections/{goldengateConnectionsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the GoldengateConnection in the following format: projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}.", "pattern": "^projects/[^/]+/locations/[^/]+/goldengateConnections/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single GoldengateConnection." } } }, "goldengateDeploymentVersions": { "methods": { "list": { "id": "oracledatabase.projects.locations.goldengateDeploymentVersions.list", "path": "v1/{+parent}/goldengateDeploymentVersions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentVersions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Parent value for ListGoldengateDeploymentVersionsRequest Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. Either the deployment_id and deployment_type fields must be specified in the format: `deployment_id=\"id\"` or `deployment_type=\"DATABASE_ORACLE\"`.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGoldengateDeploymentVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists GoldengateDeploymentVersions in a given project and location." } } }, "goldengateDeploymentTypes": { "methods": { "list": { "id": "oracledatabase.projects.locations.goldengateDeploymentTypes.list", "path": "v1/{+parent}/goldengateDeploymentTypes", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentTypes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent resource. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. Either the deployment_type and ogg_version fields must be specified in the format: `deployment_type=\"DATABASE_ORACLE\"` or `ogg_version=\"version\"`. Allowed values for deployment_type are: `DATABASE_ORACLE`, `BIGDATA`, `DATABASE_MICROSOFT_SQLSERVER`, `DATABASE_MYSQL`, `DATABASE_POSTGRESQL`, `DATABASE_DB2ZOS`, `DATABASE_DB2I`, `GGSA`, `DATA_TRANSFORMS`.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGoldengateDeploymentTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists GoldenGateDeploymentTypes in a given project and location." } } }, "goldengateDeploymentEnvironments": { "methods": { "list": { "id": "oracledatabase.projects.locations.goldengateDeploymentEnvironments.list", "path": "v1/{+parent}/goldengateDeploymentEnvironments", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentEnvironments", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent, which owns this collection of GoldengateDeploymentEnvironments. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 deployment environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGoldengateDeploymentEnvironmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists GoldengateDeploymentEnvironments in a given project and location." } } }, "goldengateConnectionTypes": { "methods": { "list": { "id": "oracledatabase.projects.locations.goldengateConnectionTypes.list", "path": "v1/{+parent}/goldengateConnectionTypes", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionTypes", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. Parent value for ListGoldengateConnectionTypesRequest Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. The connection_type field must be specified in the format: `connection_type=\"ORACLE\"`.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGoldengateConnectionTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists GoldengateConnectionTypes in a given project and location." } } }, "dbVersions": { "methods": { "list": { "id": "oracledatabase.projects.locations.dbVersions.list", "path": "v1/{+parent}/dbVersions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbVersions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for the DbVersion resource with the format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbVersions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Filter expression that matches a subset of the DbVersions to show. The supported filter for dbSystem creation is `db_system_shape = {db_system_shape} AND storage_management = {storage_management}`. If no filter is provided, all DbVersions will be returned.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDbVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List DbVersions for the given project and location." } } }, "databaseCharacterSets": { "methods": { "list": { "id": "oracledatabase.projects.locations.databaseCharacterSets.list", "path": "v1/{+parent}/databaseCharacterSets", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/databaseCharacterSets", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for DatabaseCharacterSets in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of DatabaseCharacterSets to return. The service may return fewer than this value. If unspecified, at most 50 DatabaseCharacterSets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListDatabaseCharacterSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabaseCharacterSets` must match the call that provided the page token.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type=\"{characterSetType}\"`. Accepted values include `DATABASE` and `NATIONAL`.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDatabaseCharacterSetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List DatabaseCharacterSets for the given project and location." } } }, "goldengateConnectionAssignments": { "methods": { "list": { "id": "oracledatabase.projects.locations.goldengateConnectionAssignments.list", "path": "v1/{+parent}/goldengateConnectionAssignments", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent value for the GoldengateConnectionAssignments. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of GoldengateConnectionAssignments to return. The service may return fewer than this value. If unspecified, at most 50 GoldengateConnectionAssignments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListGoldengateConnectionAssignments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoldengateConnectionAssignments` must match the call that provided the page token.", "location": "query", "type": "string" }, "filter": { "description": "Optional. A filter expression that filters GoldengateConnectionAssignments listed in the response.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"DESC\" after a field name for descending.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListGoldengateConnectionAssignmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists GoldengateConnectionAssignments in a given project and location." }, "get": { "id": "oracledatabase.projects.locations.goldengateConnectionAssignments.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments/{goldengateConnectionAssignmentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the GoldengateConnectionAssignment to retrieve. Format: projects/{project}/locations/{location}/goldengateConnectionAssignments/{goldengate_connection_assignment}", "pattern": "^projects/[^/]+/locations/[^/]+/goldengateConnectionAssignments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoldengateConnectionAssignment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single GoldengateConnectionAssignment." }, "create": { "id": "oracledatabase.projects.locations.goldengateConnectionAssignments.create", "path": "v1/{+parent}/goldengateConnectionAssignments", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource where this GoldengateConnectionAssignment will be created. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "goldengateConnectionAssignmentId": { "description": "Required. The ID of the GoldengateConnectionAssignment to create.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoldengateConnectionAssignment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new GoldengateConnectionAssignment in a given project and location." }, "delete": { "id": "oracledatabase.projects.locations.goldengateConnectionAssignments.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments/{goldengateConnectionAssignmentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the GoldengateConnectionAssignment to delete. Format: projects/{project}/locations/{location}/goldengateConnectionAssignments/{goldengate_connection_assignment}", "pattern": "^projects/[^/]+/locations/[^/]+/goldengateConnectionAssignments/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single GoldengateConnectionAssignment." }, "test": { "id": "oracledatabase.projects.locations.goldengateConnectionAssignments.test", "path": "v1/{+name}:test", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments/{goldengateConnectionAssignmentsId}:test", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name of the connection assignment for which to test connection. projects/{project}/locations/{region}/goldengateConnectionAssignments/{goldengate_connection_assignment}", "pattern": "^projects/[^/]+/locations/[^/]+/goldengateConnectionAssignments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "TestGoldengateConnectionAssignmentRequest" }, "response": { "$ref": "TestGoldengateConnectionAssignmentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Tests a single GoldengateConnectionAssignment." } } } } } } } }, "discoveryVersion": "v1", "batchPath": "batch", "id": "oracledatabase:v1", "kind": "discovery#restDescription", "endpoints": [ { "endpointUrl": "https://oracledatabase.asia-northeast2.rep.googleapis.com/", "location": "asia-northeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://oracledatabase.asia-south2.rep.googleapis.com/", "location": "asia-south2", "description": "Regional Endpoint" }, { "endpointUrl": "https://oracledatabase.asia-south1.rep.googleapis.com/", "location": "asia-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://oracledatabase.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://oracledatabase.europe-west8.rep.googleapis.com/", "location": "europe-west8", "description": "Regional Endpoint" }, { "endpointUrl": "https://oracledatabase.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2", "description": "Regional Endpoint" } ], "basePath": "", "name": "oracledatabase", "description": "The Oracle Database@Google Cloud API provides a set of APIs to manage Oracle database services, such as Exadata and Autonomous Databases.", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "schemas": { "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } } }, "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "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}`.", "type": "string" }, "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "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.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "description": "The normal, successful response of the operation. 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": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "Status": { "id": "Status", "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).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "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": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "Empty": { "id": "Empty", "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); }", "type": "object", "properties": {} }, "CancelOperationRequest": { "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {} }, "ListCloudExadataInfrastructuresResponse": { "id": "ListCloudExadataInfrastructuresResponse", "description": "The response for `CloudExadataInfrastructures.list`.", "type": "object", "properties": { "cloudExadataInfrastructures": { "description": "The list of Exadata Infrastructures.", "type": "array", "items": { "$ref": "CloudExadataInfrastructure" } }, "nextPageToken": { "description": "A token for fetching next page of response.", "type": "string" }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "type": "array", "items": { "type": "string" } } } }, "CloudExadataInfrastructure": { "id": "CloudExadataInfrastructure", "description": "Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}", "type": "string" }, "displayName": { "description": "Optional. User friendly name for this resource.", "type": "string" }, "gcpOracleZone": { "description": "Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", "type": "string" }, "entitlementId": { "description": "Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned.", "readOnly": true, "type": "string" }, "properties": { "description": "Optional. Various properties of the infra.", "$ref": "CloudExadataInfrastructureProperties" }, "labels": { "description": "Optional. Labels or tags associated with the resource.", "type": "object", "additionalProperties": { "type": "string" } }, "createTime": { "description": "Output only. The date and time that the Exadata Infrastructure was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "CloudExadataInfrastructureProperties": { "id": "CloudExadataInfrastructureProperties", "description": "Various properties of Exadata Infrastructure.", "type": "object", "properties": { "ocid": { "description": "Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", "readOnly": true, "type": "string" }, "computeCount": { "description": "Optional. The number of compute servers for the Exadata Infrastructure.", "type": "integer", "format": "int32" }, "storageCount": { "description": "Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure.", "type": "integer", "format": "int32" }, "totalStorageSizeGb": { "description": "Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB).", "type": "integer", "format": "int32" }, "availableStorageSizeGb": { "description": "Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB).", "readOnly": true, "type": "integer", "format": "int32" }, "maintenanceWindow": { "description": "Optional. Maintenance window for repair.", "$ref": "MaintenanceWindow" }, "state": { "description": "Output only. The current lifecycle state of the Exadata Infrastructure.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "The Exadata Infrastructure is being provisioned.", "The Exadata Infrastructure is available for use.", "The Exadata Infrastructure is being updated.", "The Exadata Infrastructure is being terminated.", "The Exadata Infrastructure is terminated.", "The Exadata Infrastructure is in failed state.", "The Exadata Infrastructure is in maintenance." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "MAINTENANCE_IN_PROGRESS" ] }, "shape": { "description": "Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.", "type": "string" }, "ociUrl": { "description": "Output only. Deep link to the OCI console to view this resource.", "readOnly": true, "type": "string" }, "cpuCount": { "description": "Output only. The number of enabled CPU cores.", "readOnly": true, "type": "integer", "format": "int32" }, "maxCpuCount": { "description": "Output only. The total number of CPU cores available.", "readOnly": true, "type": "integer", "format": "int32" }, "memorySizeGb": { "description": "Output only. The memory allocated in GBs.", "readOnly": true, "type": "integer", "format": "int32" }, "maxMemoryGb": { "description": "Output only. The total memory available in GBs.", "readOnly": true, "type": "integer", "format": "int32" }, "dbNodeStorageSizeGb": { "description": "Output only. The local node storage allocated in GBs.", "readOnly": true, "type": "integer", "format": "int32" }, "maxDbNodeStorageSizeGb": { "description": "Output only. The total local node storage available in GBs.", "readOnly": true, "type": "integer", "format": "int32" }, "dataStorageSizeTb": { "description": "Output only. Size, in terabytes, of the DATA disk group.", "readOnly": true, "type": "number", "format": "double" }, "maxDataStorageTb": { "description": "Output only. The total available DATA disk group size.", "readOnly": true, "type": "number", "format": "double" }, "activatedStorageCount": { "description": "Output only. The requested number of additional storage servers activated for the Exadata Infrastructure.", "readOnly": true, "type": "integer", "format": "int32" }, "additionalStorageCount": { "description": "Output only. The requested number of additional storage servers for the Exadata Infrastructure.", "readOnly": true, "type": "integer", "format": "int32" }, "dbServerVersion": { "description": "Output only. The software version of the database servers (dom0) in the Exadata Infrastructure.", "readOnly": true, "type": "string" }, "storageServerVersion": { "description": "Output only. The software version of the storage servers (cells) in the Exadata Infrastructure.", "readOnly": true, "type": "string" }, "nextMaintenanceRunId": { "description": "Output only. The OCID of the next maintenance run.", "readOnly": true, "type": "string" }, "nextMaintenanceRunTime": { "description": "Output only. The time when the next maintenance run will occur.", "readOnly": true, "type": "string", "format": "google-datetime" }, "nextSecurityMaintenanceRunTime": { "description": "Output only. The time when the next security maintenance run will occur.", "readOnly": true, "type": "string", "format": "google-datetime" }, "customerContacts": { "description": "Optional. The list of customer contacts.", "type": "array", "items": { "$ref": "CustomerContact" } }, "monthlyStorageServerVersion": { "description": "Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15", "readOnly": true, "type": "string" }, "monthlyDbServerVersion": { "description": "Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15", "readOnly": true, "type": "string" }, "computeModel": { "description": "Output only. The compute model of the Exadata Infrastructure.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified compute model.", "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", "Physical measure of compute resources. OCPUs are based on the physical core of a processor." ], "enum": [ "COMPUTE_MODEL_UNSPECIFIED", "COMPUTE_MODEL_ECPU", "COMPUTE_MODEL_OCPU" ] }, "databaseServerType": { "description": "Output only. The database server type of the Exadata Infrastructure.", "readOnly": true, "type": "string" }, "storageServerType": { "description": "Output only. The storage server type of the Exadata Infrastructure.", "readOnly": true, "type": "string" }, "exascaleConfig": { "description": "Output only. The Exascale configuration for the Exadata Infrastructure.", "readOnly": true, "$ref": "ExascaleConfig" } } }, "MaintenanceWindow": { "id": "MaintenanceWindow", "description": "Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow", "type": "object", "properties": { "preference": { "description": "Optional. The maintenance window scheduling preference.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Custom preference.", "No preference." ], "enum": [ "MAINTENANCE_WINDOW_PREFERENCE_UNSPECIFIED", "CUSTOM_PREFERENCE", "NO_PREFERENCE" ] }, "months": { "description": "Optional. Months during the year when maintenance should be performed.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "The unspecified month.", "The month of January.", "The month of February.", "The month of March.", "The month of April.", "The month of May.", "The month of June.", "The month of July.", "The month of August.", "The month of September.", "The month of October.", "The month of November.", "The month of December." ], "enum": [ "MONTH_UNSPECIFIED", "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] } }, "weeksOfMonth": { "description": "Optional. Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week.", "type": "array", "items": { "type": "integer", "format": "int32" } }, "daysOfWeek": { "description": "Optional. Days during the week when maintenance should be performed.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } }, "hoursOfDay": { "description": "Optional. The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are: 0 - represents time slot 0:00 - 3:59 UTC 4 - represents time slot 4:00 - 7:59 UTC 8 - represents time slot 8:00 - 11:59 UTC 12 - represents time slot 12:00 - 15:59 UTC 16 - represents time slot 16:00 - 19:59 UTC 20 - represents time slot 20:00 - 23:59 UTC", "type": "array", "items": { "type": "integer", "format": "int32" } }, "leadTimeWeek": { "description": "Optional. Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.", "type": "integer", "format": "int32" }, "patchingMode": { "description": "Optional. Cloud CloudExadataInfrastructure node patching method, either \"ROLLING\" or \"NONROLLING\". Default value is ROLLING.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Updates the Cloud Exadata database server hosts in a rolling fashion.", "The non-rolling maintenance method first updates your storage servers at the same time, then your database servers at the same time." ], "enum": [ "PATCHING_MODE_UNSPECIFIED", "ROLLING", "NON_ROLLING" ] }, "customActionTimeoutMins": { "description": "Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).", "type": "integer", "format": "int32" }, "isCustomActionTimeoutEnabled": { "description": "Optional. If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.", "type": "boolean" } } }, "CustomerContact": { "id": "CustomerContact", "description": "The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact", "type": "object", "properties": { "email": { "description": "Required. The email address used by Oracle to send notifications regarding databases and infrastructure.", "type": "string" } } }, "ExascaleConfig": { "id": "ExascaleConfig", "description": "Details of the Exascale configuration for the Exadata Infrastructure.", "type": "object", "properties": { "totalStorageSizeGb": { "description": "Output only. Total storage size needed for Exascale in GBs.", "readOnly": true, "type": "integer", "format": "int32" }, "availableStorageSizeGb": { "description": "Output only. Available storage size for Exascale in GBs.", "readOnly": true, "type": "integer", "format": "int32" } } }, "ConfigureExascaleCloudExadataInfrastructureRequest": { "id": "ConfigureExascaleCloudExadataInfrastructureRequest", "description": "The request for `CloudExadataInfrastructure.ConfigureExascale`.", "type": "object", "properties": { "totalStorageSizeGb": { "description": "Required. The total storage to be allocated to Exascale in GBs.", "type": "integer", "format": "int32" }, "requestId": { "description": "Optional. An optional ID to identify the request.", "type": "string" } } }, "ListCloudVmClustersResponse": { "id": "ListCloudVmClustersResponse", "description": "The response for `CloudVmCluster.List`.", "type": "object", "properties": { "cloudVmClusters": { "description": "The list of VM Clusters.", "type": "array", "items": { "$ref": "CloudVmCluster" } }, "nextPageToken": { "description": "A token to fetch the next page of results.", "type": "string" }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "type": "array", "items": { "type": "string" } } } }, "CloudVmCluster": { "id": "CloudVmCluster", "description": "Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}", "type": "string" }, "exadataInfrastructure": { "description": "Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}", "type": "string" }, "displayName": { "description": "Optional. User friendly name for this resource.", "type": "string" }, "properties": { "description": "Optional. Various properties of the VM Cluster.", "$ref": "CloudVmClusterProperties" }, "labels": { "description": "Optional. Labels or tags associated with the VM Cluster.", "type": "object", "additionalProperties": { "type": "string" } }, "createTime": { "description": "Output only. The date and time that the VM cluster was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "cidr": { "description": "Optional. Network settings. CIDR to use for cluster IP allocation.", "type": "string" }, "backupSubnetCidr": { "description": "Optional. CIDR range of the backup subnet.", "type": "string" }, "network": { "description": "Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}", "type": "string" }, "gcpOracleZone": { "description": "Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2.", "readOnly": true, "type": "string" }, "odbNetwork": { "description": "Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.", "type": "string" }, "odbSubnet": { "description": "Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "backupOdbSubnet": { "description": "Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "identityConnector": { "description": "Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.", "readOnly": true, "$ref": "IdentityConnector" }, "exascaleDbStorageVault": { "description": "Optional. The name of ExascaleDbStorageVault associated with the VM Cluster. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}", "type": "string" } } }, "CloudVmClusterProperties": { "id": "CloudVmClusterProperties", "description": "Various properties and settings associated with Exadata VM cluster.", "type": "object", "properties": { "ocid": { "description": "Output only. Oracle Cloud Infrastructure ID of VM Cluster.", "readOnly": true, "type": "string" }, "licenseType": { "description": "Required. License type of VM Cluster.", "type": "string", "enumDescriptions": [ "Unspecified", "License included part of offer", "Bring your own license" ], "enum": [ "LICENSE_TYPE_UNSPECIFIED", "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" ] }, "giVersion": { "description": "Optional. Grid Infrastructure Version.", "type": "string" }, "timeZone": { "description": "Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified.", "$ref": "TimeZone" }, "sshPublicKeys": { "description": "Optional. SSH public keys to be stored with cluster.", "type": "array", "items": { "type": "string" } }, "nodeCount": { "description": "Optional. Number of database servers.", "type": "integer", "format": "int32" }, "shape": { "description": "Output only. Shape of VM Cluster.", "readOnly": true, "type": "string" }, "ocpuCount": { "description": "Optional. OCPU count per VM. Minimum is 0.1.", "type": "number", "format": "float" }, "memorySizeGb": { "description": "Optional. Memory allocated in GBs.", "type": "integer", "format": "int32" }, "dbNodeStorageSizeGb": { "description": "Optional. Local storage per VM.", "type": "integer", "format": "int32" }, "storageSizeGb": { "description": "Output only. The storage allocation for the disk group, in gigabytes (GB).", "readOnly": true, "type": "integer", "format": "int32" }, "dataStorageSizeTb": { "description": "Optional. The data disk group size to be allocated in TBs.", "type": "number", "format": "double" }, "diskRedundancy": { "description": "Optional. The type of redundancy.", "type": "string", "enumDescriptions": [ "Unspecified.", "High - 3 way mirror.", "Normal - 2 way mirror." ], "enum": [ "DISK_REDUNDANCY_UNSPECIFIED", "HIGH", "NORMAL" ] }, "sparseDiskgroupEnabled": { "description": "Optional. Use exadata sparse snapshots.", "type": "boolean" }, "localBackupEnabled": { "description": "Optional. Use local backup.", "type": "boolean" }, "hostnamePrefix": { "description": "Optional. Prefix for VM cluster host names.", "type": "string" }, "diagnosticsDataCollectionOptions": { "description": "Optional. Data collection options for diagnostics.", "$ref": "DataCollectionOptions" }, "state": { "description": "Output only. State of the cluster.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in updating state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", "Indicates that the resource is in failed state.", "Indicates that the resource is in maintenance in progress state." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "MAINTENANCE_IN_PROGRESS" ] }, "scanListenerPortTcp": { "description": "Optional. SCAN listener port - TCP", "type": "integer", "format": "int32" }, "scanListenerPortTcpSsl": { "description": "Optional. SCAN listener port - TLS", "type": "integer", "format": "int32" }, "domain": { "description": "Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com", "readOnly": true, "type": "string" }, "scanDns": { "description": "Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com", "readOnly": true, "type": "string" }, "hostname": { "description": "Output only. host name without domain. format: \"-\" with some suffix. ex: sp2-yi0xq where \"sp2\" is the hostname_prefix.", "readOnly": true, "type": "string" }, "cpuCoreCount": { "description": "Required. Number of enabled CPU cores.", "type": "integer", "format": "int32" }, "systemVersion": { "description": "Optional. Operating system version of the image.", "type": "string" }, "scanIpIds": { "description": "Output only. OCIDs of scan IPs.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "scanDnsRecordId": { "description": "Output only. OCID of scan DNS record.", "readOnly": true, "type": "string" }, "ociUrl": { "description": "Output only. Deep link to the OCI console to view this resource.", "readOnly": true, "type": "string" }, "dbServerOcids": { "description": "Optional. OCID of database servers.", "type": "array", "items": { "type": "string" } }, "compartmentId": { "description": "Output only. Compartment ID of cluster.", "readOnly": true, "type": "string" }, "dnsListenerIp": { "description": "Output only. DNS listener IP.", "readOnly": true, "type": "string" }, "clusterName": { "description": "Optional. OCI Cluster name.", "type": "string" }, "computeModel": { "description": "Output only. The compute model of the VM Cluster.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified compute model.", "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", "Physical measure of compute resources. OCPUs are based on the physical core of a processor." ], "enum": [ "COMPUTE_MODEL_UNSPECIFIED", "COMPUTE_MODEL_ECPU", "COMPUTE_MODEL_OCPU" ] }, "storageManagementType": { "description": "Output only. The storage management type of the VM Cluster.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified storage management type.", "Automatic Storage Management.", "Exascale storage management." ], "enum": [ "STORAGE_MANAGEMENT_TYPE_UNSPECIFIED", "ASM", "EXASCALE" ] } } }, "TimeZone": { "id": "TimeZone", "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", "type": "object", "properties": { "id": { "description": "IANA Time Zone Database time zone. For example \"America/New_York\".", "type": "string" }, "version": { "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", "type": "string" } } }, "DataCollectionOptions": { "id": "DataCollectionOptions", "description": "Data collection options for diagnostics.", "type": "object", "properties": { "diagnosticsEventsEnabled": { "description": "Optional. Indicates whether diagnostic collection is enabled for the VM cluster", "type": "boolean" }, "healthMonitoringEnabled": { "description": "Optional. Indicates whether health monitoring is enabled for the VM cluster", "type": "boolean" }, "incidentLogsEnabled": { "description": "Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster", "type": "boolean" } } }, "IdentityConnector": { "id": "IdentityConnector", "description": "The identity connector details which will allow OCI to securely access the resources in the customer project.", "type": "object", "properties": { "serviceAgentEmail": { "description": "Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com`", "readOnly": true, "type": "string" }, "connectionState": { "description": "Output only. The connection state of the identity connector.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "The identity pool connection is connected.", "The identity pool connection is partially connected.", "The identity pool connection is disconnected.", "The identity pool connection is in an unknown state." ], "enum": [ "CONNECTION_STATE_UNSPECIFIED", "CONNECTED", "PARTIALLY_CONNECTED", "DISCONNECTED", "UNKNOWN" ] } } }, "ListEntitlementsResponse": { "id": "ListEntitlementsResponse", "description": "The response for `Entitlement.List`.", "type": "object", "properties": { "entitlements": { "description": "The list of Entitlements", "type": "array", "items": { "$ref": "Entitlement" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "Entitlement": { "id": "Entitlement", "description": "Details of the Entitlement resource.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Entitlement resource with the format: projects/{project}/locations/{region}/entitlements/{entitlement}", "type": "string" }, "cloudAccountDetails": { "description": "Details of the OCI Cloud Account.", "$ref": "CloudAccountDetails" }, "entitlementId": { "description": "Output only. Google Cloud Marketplace order ID (aka entitlement ID)", "readOnly": true, "type": "string" }, "state": { "description": "Output only. Entitlement State.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Account not linked.", "Account is linked but not active.", "Entitlement and Account are active.", "Account is suspended.", "Entitlement is not approved in private marketplace." ], "enum": [ "STATE_UNSPECIFIED", "ACCOUNT_NOT_LINKED", "ACCOUNT_NOT_ACTIVE", "ACTIVE", "ACCOUNT_SUSPENDED", "NOT_APPROVED_IN_PRIVATE_MARKETPLACE" ] } } }, "CloudAccountDetails": { "id": "CloudAccountDetails", "description": "Details of the OCI Cloud Account.", "type": "object", "properties": { "cloudAccount": { "description": "Output only. OCI account name.", "readOnly": true, "type": "string" }, "cloudAccountHomeRegion": { "description": "Output only. OCI account home region.", "readOnly": true, "type": "string" }, "linkExistingAccountUri": { "description": "Output only. URL to link an existing account.", "readOnly": true, "type": "string" }, "accountCreationUri": { "description": "Output only. URL to create a new account and link.", "readOnly": true, "type": "string" } } }, "ListDbServersResponse": { "id": "ListDbServersResponse", "description": "The response for `DbServer.List`.", "type": "object", "properties": { "dbServers": { "description": "The list of database servers.", "type": "array", "items": { "$ref": "DbServer" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "DbServer": { "id": "DbServer", "description": "Details of the database server resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the database server resource with the format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}", "type": "string" }, "displayName": { "description": "Optional. User friendly name for this resource.", "type": "string" }, "properties": { "description": "Optional. Various properties of the database server.", "$ref": "DbServerProperties" } } }, "DbServerProperties": { "id": "DbServerProperties", "description": "Various properties and settings associated with Exadata database server.", "type": "object", "properties": { "ocid": { "description": "Output only. OCID of database server.", "readOnly": true, "type": "string" }, "ocpuCount": { "description": "Optional. OCPU count per database.", "type": "integer", "format": "int32" }, "maxOcpuCount": { "description": "Optional. Maximum OCPU count per database.", "type": "integer", "format": "int32" }, "memorySizeGb": { "description": "Optional. Memory allocated in GBs.", "type": "integer", "format": "int32" }, "maxMemorySizeGb": { "description": "Optional. Maximum memory allocated in GBs.", "type": "integer", "format": "int32" }, "dbNodeStorageSizeGb": { "description": "Optional. Local storage per VM.", "type": "integer", "format": "int32" }, "maxDbNodeStorageSizeGb": { "description": "Optional. Maximum local storage per VM.", "type": "integer", "format": "int32" }, "vmCount": { "description": "Optional. Vm count per database.", "type": "integer", "format": "int32" }, "state": { "description": "Output only. State of the database server.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in creating state.", "Indicates that the resource is in available state.", "Indicates that the resource is in unavailable state.", "Indicates that the resource is in deleting state.", "Indicates that the resource is in deleted state." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "AVAILABLE", "UNAVAILABLE", "DELETING", "DELETED" ] }, "dbNodeIds": { "description": "Output only. OCID of database nodes associated with the database server.", "readOnly": true, "type": "array", "items": { "type": "string" } } } }, "ListDbNodesResponse": { "id": "ListDbNodesResponse", "description": "The response for `DbNode.List`.", "type": "object", "properties": { "dbNodes": { "description": "The list of DB Nodes", "type": "array", "items": { "$ref": "DbNode" } }, "nextPageToken": { "description": "A token identifying a page of results the node should return.", "type": "string" } } }, "DbNode": { "id": "DbNode", "description": "Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}", "type": "string" }, "properties": { "description": "Optional. Various properties of the database node.", "$ref": "DbNodeProperties" } } }, "DbNodeProperties": { "id": "DbNodeProperties", "description": "Various properties and settings associated with Db node.", "type": "object", "properties": { "ocid": { "description": "Output only. OCID of database node.", "readOnly": true, "type": "string" }, "ocpuCount": { "description": "Optional. OCPU count per database node.", "type": "integer", "format": "int32" }, "memorySizeGb": { "description": "Memory allocated in GBs.", "type": "integer", "format": "int32" }, "dbNodeStorageSizeGb": { "description": "Optional. Local storage per database node.", "type": "integer", "format": "int32" }, "dbServerOcid": { "description": "Optional. Database server OCID.", "type": "string" }, "hostname": { "description": "Optional. DNS", "type": "string" }, "state": { "description": "Output only. State of the database node.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in updating state.", "Indicates that the resource is in stopping state.", "Indicates that the resource is in stopped state.", "Indicates that the resource is in starting state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", "Indicates that the resource is in failed state." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "STOPPING", "STOPPED", "STARTING", "TERMINATING", "TERMINATED", "FAILED" ] }, "totalCpuCoreCount": { "description": "Total CPU core count of the database node.", "type": "integer", "format": "int32" }, "createTime": { "description": "Output only. The date and time that the database node was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "ListGiVersionsResponse": { "id": "ListGiVersionsResponse", "description": "The response for `GiVersion.List`.", "type": "object", "properties": { "giVersions": { "description": "The list of Oracle Grid Infrastructure (GI) versions.", "type": "array", "items": { "$ref": "GiVersion" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "GiVersion": { "id": "GiVersion", "description": "Details of the Oracle Grid Infrastructure (GI) version resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiVersionSummary/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Oracle Grid Infrastructure (GI) version resource with the format: projects/{project}/locations/{region}/giVersions/{gi_versions}", "type": "string" }, "version": { "description": "Optional. version", "type": "string" } } }, "ListMinorVersionsResponse": { "id": "ListMinorVersionsResponse", "description": "The response for `MinorVersion.List`.", "type": "object", "properties": { "minorVersions": { "description": "The list of MinorVersions.", "type": "array", "items": { "$ref": "MinorVersion" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "MinorVersion": { "id": "MinorVersion", "description": "MinorVersion represents a minor version of a GI. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiMinorVersionSummary/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the MinorVersion resource with the format: projects/{project}/locations/{region}/giVersions/{gi_version}/minorVersions/{minor_version}", "type": "string" }, "gridImageId": { "description": "Optional. The ID of the Grid Image.", "type": "string" }, "version": { "description": "Optional. The valid Oracle grid infrastructure software version.", "type": "string" } } }, "ListDbSystemShapesResponse": { "id": "ListDbSystemShapesResponse", "description": "The response for `DbSystemShape.List`.", "type": "object", "properties": { "dbSystemShapes": { "description": "The list of Database System shapes.", "type": "array", "items": { "$ref": "DbSystemShape" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "DbSystemShape": { "id": "DbSystemShape", "description": "Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape}", "type": "string" }, "shape": { "description": "Optional. shape", "type": "string" }, "minNodeCount": { "description": "Optional. Minimum number of database servers.", "type": "integer", "format": "int32" }, "maxNodeCount": { "description": "Optional. Maximum number of database servers.", "type": "integer", "format": "int32" }, "minStorageCount": { "description": "Optional. Minimum number of storage servers.", "type": "integer", "format": "int32" }, "maxStorageCount": { "description": "Optional. Maximum number of storage servers.", "type": "integer", "format": "int32" }, "availableCoreCountPerNode": { "description": "Optional. Number of cores per node.", "type": "integer", "format": "int32" }, "availableMemoryPerNodeGb": { "description": "Optional. Memory per database server node in gigabytes.", "type": "integer", "format": "int32" }, "availableDataStorageTb": { "description": "Optional. Storage per storage server in terabytes.", "type": "integer", "format": "int32" }, "minCoreCountPerNode": { "description": "Optional. Minimum core count per node.", "type": "integer", "format": "int32" }, "minMemoryPerNodeGb": { "description": "Optional. Minimum memory per node in gigabytes.", "type": "integer", "format": "int32" }, "minDbNodeStoragePerNodeGb": { "description": "Optional. Minimum node storage per database server in gigabytes.", "type": "integer", "format": "int32" } } }, "ListAutonomousDatabasesResponse": { "id": "ListAutonomousDatabasesResponse", "description": "The response for `AutonomousDatabase.List`.", "type": "object", "properties": { "autonomousDatabases": { "description": "The list of Autonomous Databases.", "type": "array", "items": { "$ref": "AutonomousDatabase" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "type": "array", "items": { "type": "string" } } } }, "AutonomousDatabase": { "id": "AutonomousDatabase", "description": "Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", "type": "string" }, "database": { "description": "Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.", "type": "string" }, "displayName": { "description": "Optional. Immutable. The display name for the Autonomous Database. The name does not have to be unique within your project.", "type": "string" }, "entitlementId": { "description": "Output only. The ID of the subscription entitlement associated with the Autonomous Database.", "readOnly": true, "type": "string" }, "adminPassword": { "description": "Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", "type": "string" }, "adminPasswordSecretVersion": { "description": "Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", "type": "string" }, "properties": { "description": "Optional. The properties of the Autonomous Database.", "$ref": "AutonomousDatabaseProperties" }, "labels": { "description": "Optional. The labels or tags associated with the Autonomous Database.", "type": "object", "additionalProperties": { "type": "string" } }, "network": { "description": "Optional. Immutable. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}", "type": "string" }, "cidr": { "description": "Optional. Immutable. The subnet CIDR range for the Autonomous Database.", "type": "string" }, "odbNetwork": { "description": "Optional. Immutable. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", "type": "string" }, "odbSubnet": { "description": "Optional. Immutable. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "sourceConfig": { "description": "Optional. Immutable. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation.", "$ref": "SourceConfig" }, "peerAutonomousDatabases": { "description": "Output only. The peer Autonomous Database names of the given Autonomous Database.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "createTime": { "description": "Output only. The date and time that the Autonomous Database was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "disasterRecoverySupportedLocations": { "description": "Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.", "readOnly": true, "type": "array", "items": { "type": "string" } } } }, "AutonomousDatabaseProperties": { "id": "AutonomousDatabaseProperties", "description": "The properties of an Autonomous Database.", "type": "object", "properties": { "ocid": { "description": "Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", "readOnly": true, "type": "string" }, "computeCount": { "description": "Optional. Immutable. The number of compute servers for the Autonomous Database.", "type": "number", "format": "float" }, "cpuCoreCount": { "description": "Optional. Immutable. The number of CPU cores to be made available to the database.", "type": "integer", "format": "int32" }, "dataStorageSizeTb": { "description": "Optional. Immutable. The size of the data stored in the database, in terabytes.", "type": "integer", "format": "int32" }, "dataStorageSizeGb": { "description": "Optional. Immutable. The size of the data stored in the database, in gigabytes.", "type": "integer", "format": "int32" }, "dbWorkload": { "description": "Required. Immutable. The workload type of the Autonomous Database.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Autonomous Transaction Processing database.", "Autonomous Data Warehouse database.", "Autonomous JSON Database.", "Autonomous Database with the Oracle APEX Application Development workload type." ], "enum": [ "DB_WORKLOAD_UNSPECIFIED", "OLTP", "DW", "AJD", "APEX" ] }, "dbEdition": { "description": "Optional. Immutable. The edition of the Autonomous Databases.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Standard Database Edition", "Enterprise Database Edition" ], "enum": [ "DATABASE_EDITION_UNSPECIFIED", "STANDARD_EDITION", "ENTERPRISE_EDITION" ] }, "characterSet": { "description": "Optional. Immutable. The character set for the Autonomous Database. The default is AL32UTF8.", "type": "string" }, "nCharacterSet": { "description": "Optional. Immutable. The national character set for the Autonomous Database. The default is AL16UTF16.", "type": "string" }, "privateEndpointIp": { "description": "Optional. Immutable. The private endpoint IP address for the Autonomous Database.", "type": "string" }, "privateEndpointLabel": { "description": "Optional. Immutable. The private endpoint label for the Autonomous Database.", "type": "string" }, "dbVersion": { "description": "Optional. Immutable. The Oracle Database version for the Autonomous Database.", "type": "string" }, "isAutoScalingEnabled": { "description": "Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.", "type": "boolean" }, "isStorageAutoScalingEnabled": { "description": "Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database storage.", "type": "boolean" }, "licenseType": { "description": "Required. Immutable. The license type used for the Autonomous Database.", "type": "string", "enumDescriptions": [ "Unspecified", "License included part of offer", "Bring your own license" ], "enum": [ "LICENSE_TYPE_UNSPECIFIED", "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" ] }, "customerContacts": { "description": "Optional. Immutable. The list of customer contacts.", "type": "array", "items": { "$ref": "CustomerContact" } }, "secretId": { "description": "Optional. Immutable. The ID of the Oracle Cloud Infrastructure vault secret.", "type": "string" }, "vaultId": { "description": "Optional. Immutable. The ID of the Oracle Cloud Infrastructure vault.", "type": "string" }, "maintenanceScheduleType": { "description": "Optional. Immutable. The maintenance schedule of the Autonomous Database.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "An EARLY maintenance schedule patches the database before the regular scheduled maintenance.", "A REGULAR maintenance schedule follows the normal maintenance cycle." ], "enum": [ "MAINTENANCE_SCHEDULE_TYPE_UNSPECIFIED", "EARLY", "REGULAR" ] }, "mtlsConnectionRequired": { "description": "Optional. Immutable. This field specifies if the Autonomous Database requires mTLS connections.", "type": "boolean" }, "backupRetentionPeriodDays": { "description": "Optional. Immutable. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.", "type": "integer", "format": "int32" }, "actualUsedDataStorageSizeTb": { "description": "Output only. The amount of storage currently being used for user and system data, in terabytes.", "readOnly": true, "type": "number", "format": "double" }, "allocatedStorageSizeTb": { "description": "Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.", "readOnly": true, "type": "number", "format": "double" }, "apexDetails": { "description": "Output only. The details for the Oracle APEX Application Development.", "readOnly": true, "$ref": "AutonomousDatabaseApex" }, "arePrimaryAllowlistedIpsUsed": { "description": "Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.", "readOnly": true, "type": "boolean" }, "lifecycleDetails": { "description": "Output only. The details of the current lifestyle state of the Autonomous Database.", "readOnly": true, "type": "string" }, "state": { "description": "Output only. The current lifecycle state of the Autonomous Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the Autonomous Database is in provisioning state.", "Indicates that the Autonomous Database is in available state.", "Indicates that the Autonomous Database is in stopping state.", "Indicates that the Autonomous Database is in stopped state.", "Indicates that the Autonomous Database is in starting state.", "Indicates that the Autonomous Database is in terminating state.", "Indicates that the Autonomous Database is in terminated state.", "Indicates that the Autonomous Database is in unavailable state.", "Indicates that the Autonomous Database restore is in progress.", "Indicates that the Autonomous Database failed to restore.", "Indicates that the Autonomous Database backup is in progress.", "Indicates that the Autonomous Database scale is in progress.", "Indicates that the Autonomous Database is available but needs attention state.", "Indicates that the Autonomous Database is in updating state.", "Indicates that the Autonomous Database's maintenance is in progress state.", "Indicates that the Autonomous Database is in restarting state.", "Indicates that the Autonomous Database is in recreating state.", "Indicates that the Autonomous Database's role change is in progress state.", "Indicates that the Autonomous Database is in upgrading state.", "Indicates that the Autonomous Database is in inaccessible state.", "Indicates that the Autonomous Database is in standby state." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "STOPPING", "STOPPED", "STARTING", "TERMINATING", "TERMINATED", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "UPDATING", "MAINTENANCE_IN_PROGRESS", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY" ] }, "autonomousContainerDatabaseId": { "description": "Output only. The Autonomous Container Database OCID.", "readOnly": true, "type": "string" }, "availableUpgradeVersions": { "description": "Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "connectionStrings": { "description": "Output only. The connection strings used to connect to an Autonomous Database.", "readOnly": true, "$ref": "AutonomousDatabaseConnectionStrings" }, "connectionUrls": { "description": "Output only. The Oracle Connection URLs for an Autonomous Database.", "readOnly": true, "$ref": "AutonomousDatabaseConnectionUrls" }, "failedDataRecoveryDuration": { "description": "Output only. This field indicates the number of seconds of data loss during a Data Guard failover.", "readOnly": true, "type": "string", "format": "google-duration" }, "memoryTableGbs": { "description": "Output only. The memory assigned to in-memory tables in an Autonomous Database.", "readOnly": true, "type": "integer", "format": "int32" }, "isLocalDataGuardEnabled": { "description": "Output only. Deprecated: Please use `local_data_guard_enabled` instead. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.", "readOnly": true, "deprecated": true, "type": "boolean" }, "localAdgAutoFailoverMaxDataLossLimit": { "description": "Output only. Deprecated: Please use `local_adg_auto_failover_max_data_loss_limit_duration` instead. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", "readOnly": true, "deprecated": true, "type": "integer", "format": "int32" }, "localStandbyDb": { "description": "Output only. The details of the Autonomous Data Guard standby database.", "readOnly": true, "$ref": "AutonomousDatabaseStandbySummary" }, "memoryPerOracleComputeUnitGbs": { "description": "Output only. The amount of memory enabled per ECPU, in gigabytes.", "readOnly": true, "type": "integer", "format": "int32" }, "localDisasterRecoveryType": { "description": "Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Autonomous Data Guard recovery.", "Backup based recovery.", "Local disaster recovery is not available." ], "enum": [ "LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED", "ADG", "BACKUP_BASED", "NOT_AVAILABLE" ] }, "dataSafeState": { "description": "Output only. The current state of the Data Safe registration for the Autonomous Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Registering data safe state.", "Registered data safe state.", "Deregistering data safe state.", "Not registered data safe state.", "Failed data safe state." ], "enum": [ "DATA_SAFE_STATE_UNSPECIFIED", "REGISTERING", "REGISTERED", "DEREGISTERING", "NOT_REGISTERED", "FAILED" ] }, "databaseManagementState": { "description": "Output only. The current state of database management for the Autonomous Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Enabling Database Management state", "Enabled Database Management state", "Disabling Database Management state", "Not Enabled Database Management state", "Failed enabling Database Management state", "Failed disabling Database Management state" ], "enum": [ "DATABASE_MANAGEMENT_STATE_UNSPECIFIED", "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING" ] }, "openMode": { "description": "Output only. This field indicates the current mode of the Autonomous Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Read Only Mode", "Read Write Mode" ], "enum": [ "OPEN_MODE_UNSPECIFIED", "READ_ONLY", "READ_WRITE" ] }, "operationsInsightsState": { "description": "Output only. This field indicates the state of Operations Insights for the Autonomous Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Enabling status for operation insights.", "Enabled status for operation insights.", "Disabling status for operation insights.", "Not Enabled status for operation insights.", "Failed enabling status for operation insights.", "Failed disabling status for operation insights." ], "enum": [ "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED", "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING" ] }, "peerDbIds": { "description": "Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "permissionLevel": { "description": "Output only. The permission level of the Autonomous Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Restricted mode allows access only by admin users.", "Normal access." ], "enum": [ "PERMISSION_LEVEL_UNSPECIFIED", "RESTRICTED", "UNRESTRICTED" ] }, "privateEndpoint": { "description": "Output only. The private endpoint for the Autonomous Database.", "readOnly": true, "type": "string" }, "refreshableMode": { "description": "Output only. The refresh mode of the cloned Autonomous Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default unspecified value.", "AUTOMATIC indicates that the cloned database is automatically refreshed with data from the source Autonomous Database.", "MANUAL indicates that the cloned database is manually refreshed with data from the source Autonomous Database." ], "enum": [ "REFRESHABLE_MODE_UNSPECIFIED", "AUTOMATIC", "MANUAL" ] }, "refreshableState": { "description": "Output only. The refresh State of the clone.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Refreshing", "Not refreshed" ], "enum": [ "REFRESHABLE_STATE_UNSPECIFIED", "REFRESHING", "NOT_REFRESHING" ] }, "role": { "description": "Output only. The Data Guard role of the Autonomous Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Primary role", "Standby role", "Disabled standby role", "Backup copy role", "Snapshot standby role" ], "enum": [ "ROLE_UNSPECIFIED", "PRIMARY", "STANDBY", "DISABLED_STANDBY", "BACKUP_COPY", "SNAPSHOT_STANDBY" ] }, "scheduledOperationDetails": { "description": "Output only. The list and details of the scheduled operations of the Autonomous Database.", "readOnly": true, "type": "array", "items": { "$ref": "ScheduledOperationDetails" } }, "sqlWebDeveloperUrl": { "description": "Output only. The SQL Web Developer URL for the Autonomous Database.", "readOnly": true, "type": "string" }, "supportedCloneRegions": { "description": "Output only. The list of available regions that can be used to create a clone for the Autonomous Database.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "usedDataStorageSizeTbs": { "description": "Output only. The storage space used by Autonomous Database, in gigabytes.", "readOnly": true, "type": "integer", "format": "int32" }, "ociUrl": { "description": "Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.", "readOnly": true, "type": "string" }, "totalAutoBackupStorageSizeGbs": { "description": "Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.", "readOnly": true, "type": "number", "format": "float" }, "nextLongTermBackupTime": { "description": "Output only. The long term backup schedule of the Autonomous Database.", "readOnly": true, "type": "string", "format": "google-datetime" }, "dataGuardRoleChangedTime": { "description": "Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database.", "readOnly": true, "type": "string", "format": "google-datetime" }, "disasterRecoveryRoleChangedTime": { "description": "Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database.", "readOnly": true, "type": "string", "format": "google-datetime" }, "maintenanceBeginTime": { "description": "Output only. The date and time when maintenance will begin.", "readOnly": true, "type": "string", "format": "google-datetime" }, "maintenanceEndTime": { "description": "Output only. The date and time when maintenance will end.", "readOnly": true, "type": "string", "format": "google-datetime" }, "allowlistedIps": { "description": "Optional. Immutable. The list of allowlisted IP addresses for the Autonomous Database.", "type": "array", "items": { "type": "string" } }, "encryptionKey": { "description": "Optional. The encryption key used to encrypt the Autonomous Database. Updating this field will add a new entry in the `encryption_key_history_entries` field with the former version.", "$ref": "EncryptionKey" }, "encryptionKeyHistoryEntries": { "description": "Output only. The history of the encryption keys used to encrypt the Autonomous Database.", "readOnly": true, "type": "array", "items": { "$ref": "EncryptionKeyHistoryEntry" } }, "serviceAgentEmail": { "description": "Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project.", "readOnly": true, "type": "string" }, "localDataGuardEnabled": { "description": "Optional. Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable to cross-region Data Guard or dedicated Exadata infrastructure.", "type": "boolean" }, "localAdgAutoFailoverMaxDataLossLimitDuration": { "description": "Optional. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", "type": "integer", "format": "int32" } } }, "AutonomousDatabaseApex": { "id": "AutonomousDatabaseApex", "description": "Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex", "type": "object", "properties": { "apexVersion": { "description": "Output only. The Oracle APEX Application Development version.", "readOnly": true, "type": "string" }, "ordsVersion": { "description": "Output only. The Oracle REST Data Services (ORDS) version.", "readOnly": true, "type": "string" } } }, "AutonomousDatabaseConnectionStrings": { "id": "AutonomousDatabaseConnectionStrings", "description": "The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings", "type": "object", "properties": { "allConnectionStrings": { "description": "Output only. Returns all connection strings that can be used to connect to the Autonomous Database.", "readOnly": true, "$ref": "AllConnectionStrings" }, "dedicated": { "description": "Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", "readOnly": true, "type": "string" }, "high": { "description": "Output only. The database service provides the highest level of resources to each SQL statement.", "readOnly": true, "type": "string" }, "low": { "description": "Output only. The database service provides the least level of resources to each SQL statement.", "readOnly": true, "type": "string" }, "medium": { "description": "Output only. The database service provides a lower level of resources to each SQL statement.", "readOnly": true, "type": "string" }, "profiles": { "description": "Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.", "readOnly": true, "type": "array", "items": { "$ref": "DatabaseConnectionStringProfile" } } } }, "AllConnectionStrings": { "id": "AllConnectionStrings", "description": "A list of all connection strings that can be used to connect to the Autonomous Database.", "type": "object", "properties": { "high": { "description": "Output only. The database service provides the highest level of resources to each SQL statement.", "readOnly": true, "type": "string" }, "low": { "description": "Output only. The database service provides the least level of resources to each SQL statement.", "readOnly": true, "type": "string" }, "medium": { "description": "Output only. The database service provides a lower level of resources to each SQL statement.", "readOnly": true, "type": "string" } } }, "DatabaseConnectionStringProfile": { "id": "DatabaseConnectionStringProfile", "description": "The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile", "type": "object", "properties": { "consumerGroup": { "description": "Output only. The current consumer group being used by the connection.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "High consumer group.", "Medium consumer group.", "Low consumer group.", "TP consumer group.", "TPURGENT consumer group." ], "enum": [ "CONSUMER_GROUP_UNSPECIFIED", "HIGH", "MEDIUM", "LOW", "TP", "TPURGENT" ] }, "displayName": { "description": "Output only. The display name for the database connection.", "readOnly": true, "type": "string" }, "hostFormat": { "description": "Output only. The host name format being currently used in connection string.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "FQDN", "IP" ], "enum": [ "HOST_FORMAT_UNSPECIFIED", "FQDN", "IP" ] }, "isRegional": { "description": "Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.", "readOnly": true, "type": "boolean" }, "protocol": { "description": "Output only. The protocol being used by the connection.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Tcp", "Tcps" ], "enum": [ "PROTOCOL_UNSPECIFIED", "TCP", "TCPS" ] }, "sessionMode": { "description": "Output only. The current session mode of the connection.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Direct", "Indirect" ], "enum": [ "SESSION_MODE_UNSPECIFIED", "DIRECT", "INDIRECT" ] }, "syntaxFormat": { "description": "Output only. The syntax of the connection string.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Long", "Ezconnect", "Ezconnectplus" ], "enum": [ "SYNTAX_FORMAT_UNSPECIFIED", "LONG", "EZCONNECT", "EZCONNECTPLUS" ] }, "tlsAuthentication": { "description": "Output only. This field indicates the TLS authentication type of the connection.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Server", "Mutual" ], "enum": [ "TLS_AUTHENTICATION_UNSPECIFIED", "SERVER", "MUTUAL" ] }, "value": { "description": "Output only. The value of the connection string.", "readOnly": true, "type": "string" } } }, "AutonomousDatabaseConnectionUrls": { "id": "AutonomousDatabaseConnectionUrls", "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls", "type": "object", "properties": { "apexUri": { "description": "Output only. Oracle Application Express (APEX) URL.", "readOnly": true, "type": "string" }, "databaseTransformsUri": { "description": "Output only. The URL of the Database Transforms for the Autonomous Database.", "readOnly": true, "type": "string" }, "graphStudioUri": { "description": "Output only. The URL of the Graph Studio for the Autonomous Database.", "readOnly": true, "type": "string" }, "machineLearningNotebookUri": { "description": "Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.", "readOnly": true, "type": "string" }, "machineLearningUserManagementUri": { "description": "Output only. The URL of Machine Learning user management the Autonomous Database.", "readOnly": true, "type": "string" }, "mongoDbUri": { "description": "Output only. The URL of the MongoDB API for the Autonomous Database.", "readOnly": true, "type": "string" }, "ordsUri": { "description": "Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", "readOnly": true, "type": "string" }, "sqlDevWebUri": { "description": "Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.", "readOnly": true, "type": "string" } } }, "AutonomousDatabaseStandbySummary": { "id": "AutonomousDatabaseStandbySummary", "description": "Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary", "type": "object", "properties": { "lagTimeDuration": { "description": "Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database.", "readOnly": true, "type": "string", "format": "google-duration" }, "lifecycleDetails": { "description": "Output only. The additional details about the current lifecycle state of the Autonomous Database.", "readOnly": true, "type": "string" }, "state": { "description": "Output only. The current lifecycle state of the Autonomous Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the Autonomous Database is in provisioning state.", "Indicates that the Autonomous Database is in available state.", "Indicates that the Autonomous Database is in stopping state.", "Indicates that the Autonomous Database is in stopped state.", "Indicates that the Autonomous Database is in starting state.", "Indicates that the Autonomous Database is in terminating state.", "Indicates that the Autonomous Database is in terminated state.", "Indicates that the Autonomous Database is in unavailable state.", "Indicates that the Autonomous Database restore is in progress.", "Indicates that the Autonomous Database failed to restore.", "Indicates that the Autonomous Database backup is in progress.", "Indicates that the Autonomous Database scale is in progress.", "Indicates that the Autonomous Database is available but needs attention state.", "Indicates that the Autonomous Database is in updating state.", "Indicates that the Autonomous Database's maintenance is in progress state.", "Indicates that the Autonomous Database is in restarting state.", "Indicates that the Autonomous Database is in recreating state.", "Indicates that the Autonomous Database's role change is in progress state.", "Indicates that the Autonomous Database is in upgrading state.", "Indicates that the Autonomous Database is in inaccessible state.", "Indicates that the Autonomous Database is in standby state." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "STOPPING", "STOPPED", "STARTING", "TERMINATING", "TERMINATED", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "UPDATING", "MAINTENANCE_IN_PROGRESS", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY" ] }, "dataGuardRoleChangedTime": { "description": "Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.", "readOnly": true, "type": "string", "format": "google-datetime" }, "disasterRecoveryRoleChangedTime": { "description": "Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "ScheduledOperationDetails": { "id": "ScheduledOperationDetails", "description": "Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails", "type": "object", "properties": { "dayOfWeek": { "description": "Output only. Day of week.", "readOnly": true, "type": "string", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "startTime": { "description": "Output only. Auto start time.", "readOnly": true, "$ref": "TimeOfDay" }, "stopTime": { "description": "Output only. Auto stop time.", "readOnly": true, "$ref": "TimeOfDay" } } }, "TimeOfDay": { "id": "TimeOfDay", "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "type": "object", "properties": { "hours": { "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "type": "integer", "format": "int32" }, "minutes": { "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "type": "integer", "format": "int32" }, "seconds": { "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "type": "integer", "format": "int32" }, "nanos": { "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "type": "integer", "format": "int32" } } }, "EncryptionKey": { "id": "EncryptionKey", "description": "The encryption key used to encrypt the Autonomous Database.", "type": "object", "properties": { "provider": { "description": "Optional. The provider of the encryption key.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Google Managed KMS key, if selected, please provide the KMS key name.", "Oracle Managed." ], "enum": [ "PROVIDER_UNSPECIFIED", "GOOGLE_MANAGED", "ORACLE_MANAGED" ] }, "kmsKey": { "description": "Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", "type": "string" } } }, "EncryptionKeyHistoryEntry": { "id": "EncryptionKeyHistoryEntry", "description": "The history of the encryption keys used to encrypt the Autonomous Database.", "type": "object", "properties": { "encryptionKey": { "description": "Output only. The encryption key used to encrypt the Autonomous Database.", "readOnly": true, "$ref": "EncryptionKey" }, "activationTime": { "description": "Output only. The date and time when the encryption key was activated on the Autonomous Database..", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "SourceConfig": { "id": "SourceConfig", "description": "The source configuration for the standby Autonomous Database.", "type": "object", "properties": { "autonomousDatabase": { "description": "Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source.", "type": "string" }, "automaticBackupsReplicationEnabled": { "description": "Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard.", "type": "boolean" } } }, "RestoreAutonomousDatabaseRequest": { "id": "RestoreAutonomousDatabaseRequest", "description": "The request for `AutonomousDatabase.Restore`.", "type": "object", "properties": { "restoreTime": { "description": "Required. The time and date to restore the database to.", "type": "string", "format": "google-datetime" } } }, "GenerateAutonomousDatabaseWalletRequest": { "id": "GenerateAutonomousDatabaseWalletRequest", "description": "The request for `AutonomousDatabase.GenerateWallet`.", "type": "object", "properties": { "type": { "description": "Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Used to generate wallet for all databases in the region.", "Used to generate wallet for a single database." ], "enum": [ "GENERATE_TYPE_UNSPECIFIED", "ALL", "SINGLE" ] }, "isRegional": { "description": "Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only.", "type": "boolean" }, "password": { "description": "Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters.", "type": "string" } } }, "GenerateAutonomousDatabaseWalletResponse": { "id": "GenerateAutonomousDatabaseWalletResponse", "description": "The response for `AutonomousDatabase.GenerateWallet`.", "type": "object", "properties": { "archiveContent": { "description": "Output only. The base64 encoded wallet files.", "readOnly": true, "type": "string", "format": "byte" } } }, "ListAutonomousDbVersionsResponse": { "id": "ListAutonomousDbVersionsResponse", "description": "The response for `AutonomousDbVersion.List`.", "type": "object", "properties": { "autonomousDbVersions": { "description": "The list of Autonomous Database versions.", "type": "array", "items": { "$ref": "AutonomousDbVersion" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "AutonomousDbVersion": { "id": "AutonomousDbVersion", "description": "Details of the Autonomous Database version. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Autonomous Database Version resource with the format: projects/{project}/locations/{region}/autonomousDbVersions/{autonomous_db_version}", "type": "string" }, "version": { "description": "Output only. An Oracle Database version for Autonomous Database.", "readOnly": true, "type": "string" }, "dbWorkload": { "description": "Output only. The Autonomous Database workload type.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Autonomous Transaction Processing database.", "Autonomous Data Warehouse database.", "Autonomous JSON Database.", "Autonomous Database with the Oracle APEX Application Development workload type." ], "enum": [ "DB_WORKLOAD_UNSPECIFIED", "OLTP", "DW", "AJD", "APEX" ] }, "workloadUri": { "description": "Output only. A URL that points to a detailed description of the Autonomous Database version.", "readOnly": true, "type": "string" } } }, "ListAutonomousDatabaseCharacterSetsResponse": { "id": "ListAutonomousDatabaseCharacterSetsResponse", "description": "The response for `AutonomousDatabaseCharacterSet.List`.", "type": "object", "properties": { "autonomousDatabaseCharacterSets": { "description": "The list of Autonomous Database Character Sets.", "type": "array", "items": { "$ref": "AutonomousDatabaseCharacterSet" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "AutonomousDatabaseCharacterSet": { "id": "AutonomousDatabaseCharacterSet", "description": "Details of the Autonomous Database character set resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Autonomous Database Character Set resource in the following format: projects/{project}/locations/{region}/autonomousDatabaseCharacterSets/{autonomous_database_character_set}", "type": "string" }, "characterSetType": { "description": "Output only. The character set type for the Autonomous Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Character set type is not specified.", "Character set type is set to database.", "Character set type is set to national." ], "enum": [ "CHARACTER_SET_TYPE_UNSPECIFIED", "DATABASE", "NATIONAL" ] }, "characterSet": { "description": "Output only. The character set name for the Autonomous Database which is the ID in the resource name.", "readOnly": true, "type": "string" } } }, "ListAutonomousDatabaseBackupsResponse": { "id": "ListAutonomousDatabaseBackupsResponse", "description": "The response for `AutonomousDatabaseBackup.List`.", "type": "object", "properties": { "autonomousDatabaseBackups": { "description": "The list of Autonomous Database Backups.", "type": "array", "items": { "$ref": "AutonomousDatabaseBackup" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "AutonomousDatabaseBackup": { "id": "AutonomousDatabaseBackup", "description": "Details of the Autonomous Database Backup resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Autonomous Database Backup resource with the format: projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomous_database_backup}", "type": "string" }, "autonomousDatabase": { "description": "Required. The name of the Autonomous Database resource for which the backup is being created. Format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", "type": "string" }, "displayName": { "description": "Optional. User friendly name for the Backup. The name does not have to be unique.", "type": "string" }, "properties": { "description": "Optional. Various properties of the backup.", "$ref": "AutonomousDatabaseBackupProperties" }, "labels": { "description": "Optional. labels or tags associated with the resource.", "type": "object", "additionalProperties": { "type": "string" } } } }, "AutonomousDatabaseBackupProperties": { "id": "AutonomousDatabaseBackupProperties", "description": "Properties of the Autonomous Database Backup resource.", "type": "object", "properties": { "ocid": { "description": "Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", "readOnly": true, "type": "string" }, "retentionPeriodDays": { "description": "Optional. Retention period in days for the backup.", "type": "integer", "format": "int32" }, "compartmentId": { "description": "Output only. The OCID of the compartment.", "readOnly": true, "type": "string" }, "databaseSizeTb": { "description": "Output only. The quantity of data in the database, in terabytes.", "readOnly": true, "type": "number", "format": "float" }, "dbVersion": { "description": "Output only. A valid Oracle Database version for Autonomous Database.", "readOnly": true, "type": "string" }, "isLongTermBackup": { "description": "Output only. Indicates if the backup is long term backup.", "readOnly": true, "type": "boolean" }, "isAutomaticBackup": { "description": "Output only. Indicates if the backup is automatic or user initiated.", "readOnly": true, "type": "boolean" }, "isRestorable": { "description": "Output only. Indicates if the backup can be used to restore the Autonomous Database.", "readOnly": true, "type": "boolean" }, "keyStoreId": { "description": "Optional. The OCID of the key store of Oracle Vault.", "type": "string" }, "keyStoreWallet": { "description": "Optional. The wallet name for Oracle Key Vault.", "type": "string" }, "kmsKeyId": { "description": "Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.", "type": "string" }, "kmsKeyVersionId": { "description": "Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.", "type": "string" }, "lifecycleDetails": { "description": "Output only. Additional information about the current lifecycle state.", "readOnly": true, "type": "string" }, "lifecycleState": { "description": "Output only. The lifecycle state of the backup.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in creating state.", "Indicates that the resource is in active state.", "Indicates that the resource is in deleting state.", "Indicates that the resource is in deleted state.", "Indicates that the resource is in failed state.", "Indicates that the resource is in updating state." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING" ] }, "sizeTb": { "description": "Output only. The backup size in terabytes.", "readOnly": true, "type": "number", "format": "float" }, "availableTillTime": { "description": "Output only. Timestamp until when the backup will be available.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The date and time the backup completed.", "readOnly": true, "type": "string", "format": "google-datetime" }, "startTime": { "description": "Output only. The date and time the backup started.", "readOnly": true, "type": "string", "format": "google-datetime" }, "type": { "description": "Output only. The type of the backup.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Incremental backups.", "Full backups.", "Long term backups." ], "enum": [ "TYPE_UNSPECIFIED", "INCREMENTAL", "FULL", "LONG_TERM" ] }, "vaultId": { "description": "Optional. The OCID of the vault.", "type": "string" } } }, "StopAutonomousDatabaseRequest": { "id": "StopAutonomousDatabaseRequest", "description": "The request for `AutonomousDatabase.Stop`.", "type": "object", "properties": {} }, "StartAutonomousDatabaseRequest": { "id": "StartAutonomousDatabaseRequest", "description": "The request for `AutonomousDatabase.Start`.", "type": "object", "properties": {} }, "RestartAutonomousDatabaseRequest": { "id": "RestartAutonomousDatabaseRequest", "description": "The request for `AutonomousDatabase.Restart`.", "type": "object", "properties": {} }, "SwitchoverAutonomousDatabaseRequest": { "id": "SwitchoverAutonomousDatabaseRequest", "description": "The request for `OracleDatabase.SwitchoverAutonomousDatabase`.", "type": "object", "properties": { "peerAutonomousDatabase": { "description": "Optional. The peer database name to switch over to. Required for cross-region standby, and must be omitted for in-region Data Guard.", "type": "string" } } }, "FailoverAutonomousDatabaseRequest": { "id": "FailoverAutonomousDatabaseRequest", "description": "The request for `OracleDatabase.FailoverAutonomousDatabase`.", "type": "object", "properties": { "peerAutonomousDatabase": { "description": "Optional. The peer database name to fail over to. Required for cross-region standby, and must be omitted for in-region Data Guard.", "type": "string" } } }, "ListOdbNetworksResponse": { "id": "ListOdbNetworksResponse", "description": "The response for `OdbNetwork.List`.", "type": "object", "properties": { "odbNetworks": { "description": "The list of ODB Networks.", "type": "array", "items": { "$ref": "OdbNetwork" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "type": "array", "items": { "type": "string" } } } }, "OdbNetwork": { "id": "OdbNetwork", "description": "Represents OdbNetwork resource.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the OdbNetwork resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}", "type": "string" }, "network": { "description": "Required. The name of the VPC network in the following format: projects/{project}/global/networks/{network}", "type": "string" }, "labels": { "description": "Optional. Labels or tags associated with the resource.", "type": "object", "additionalProperties": { "type": "string" } }, "createTime": { "description": "Output only. The date and time that the OdbNetwork was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. State of the ODB Network.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in failed state." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "TERMINATING", "FAILED" ] }, "entitlementId": { "description": "Output only. The ID of the subscription entitlement associated with the OdbNetwork.", "readOnly": true, "type": "string" }, "gcpOracleZone": { "description": "Optional. The GCP Oracle zone where OdbNetwork is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", "type": "string" } } }, "ListOdbSubnetsResponse": { "id": "ListOdbSubnetsResponse", "description": "The response for `OdbSubnet.List`.", "type": "object", "properties": { "odbSubnets": { "description": "The list of ODB Subnets.", "type": "array", "items": { "$ref": "OdbSubnet" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "type": "array", "items": { "type": "string" } } } }, "OdbSubnet": { "id": "OdbSubnet", "description": "Represents OdbSubnet resource.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the OdbSubnet resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "cidrRange": { "description": "Required. The CIDR range of the subnet.", "type": "string" }, "purpose": { "description": "Required. Purpose of the subnet.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Subnet to be used for client connections.", "Subnet to be used for backup." ], "enum": [ "PURPOSE_UNSPECIFIED", "CLIENT_SUBNET", "BACKUP_SUBNET" ] }, "labels": { "description": "Optional. Labels or tags associated with the resource.", "type": "object", "additionalProperties": { "type": "string" } }, "createTime": { "description": "Output only. The date and time that the OdbNetwork was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. State of the ODB Subnet.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in failed state." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "TERMINATING", "FAILED" ] } } }, "ListExadbVmClustersResponse": { "id": "ListExadbVmClustersResponse", "description": "The response for `ExadbVmCluster.List`.", "type": "object", "properties": { "exadbVmClusters": { "description": "The list of ExadbVmClusters.", "type": "array", "items": { "$ref": "ExadbVmCluster" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "type": "array", "items": { "type": "string" } } } }, "ExadbVmCluster": { "id": "ExadbVmCluster", "description": "ExadbVmCluster represents a cluster of VMs that are used to run Exadata workloads. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}", "type": "string" }, "properties": { "description": "Required. The properties of the ExadbVmCluster.", "$ref": "ExadbVmClusterProperties" }, "gcpOracleZone": { "description": "Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault.", "readOnly": true, "type": "string" }, "labels": { "description": "Optional. The labels or tags associated with the ExadbVmCluster.", "type": "object", "additionalProperties": { "type": "string" } }, "odbNetwork": { "description": "Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", "type": "string" }, "odbSubnet": { "description": "Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "backupOdbSubnet": { "description": "Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "displayName": { "description": "Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.", "type": "string" }, "createTime": { "description": "Output only. The date and time that the ExadbVmCluster was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "entitlementId": { "description": "Output only. The ID of the subscription entitlement associated with the ExadbVmCluster.", "readOnly": true, "type": "string" } } }, "ExadbVmClusterProperties": { "id": "ExadbVmClusterProperties", "description": "The properties of an ExadbVmCluster.", "type": "object", "properties": { "clusterName": { "description": "Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name.", "type": "string" }, "gridImageId": { "description": "Required. Immutable. Grid Infrastructure Version.", "type": "string" }, "nodeCount": { "description": "Required. The number of nodes/VMs in the ExadbVmCluster.", "type": "integer", "format": "int32" }, "enabledEcpuCountPerNode": { "description": "Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure.", "type": "integer", "format": "int32" }, "additionalEcpuCountPerNode": { "description": "Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure.", "type": "integer", "format": "int32" }, "vmFileSystemStorage": { "description": "Required. Immutable. Total storage details for the ExadbVmCluster.", "$ref": "ExadbVmClusterStorageDetails" }, "licenseModel": { "description": "Optional. Immutable. The license type of the ExadbVmCluster.", "type": "string", "enumDescriptions": [ "Unspecified.", "Default is license included.", "Bring your own license." ], "enum": [ "LICENSE_MODEL_UNSPECIFIED", "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" ] }, "exascaleDbStorageVault": { "description": "Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}", "type": "string" }, "hostnamePrefix": { "description": "Required. Immutable. Prefix for VM cluster host names.", "type": "string" }, "hostname": { "description": "Output only. The hostname of the ExadbVmCluster.", "readOnly": true, "type": "string" }, "sshPublicKeys": { "description": "Required. Immutable. The SSH public keys for the ExadbVmCluster.", "type": "array", "items": { "type": "string" } }, "dataCollectionOptions": { "description": "Optional. Immutable. Indicates user preference for data collection options.", "$ref": "DataCollectionOptionsCommon" }, "timeZone": { "description": "Optional. Immutable. The time zone of the ExadbVmCluster.", "$ref": "TimeZone" }, "lifecycleState": { "description": "Output only. State of the cluster.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in updating state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", "Indicates that the resource is in failed state.", "Indicates that the resource is in maintenance in progress state." ], "enum": [ "EXADB_VM_CLUSTER_LIFECYCLE_STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "MAINTENANCE_IN_PROGRESS" ] }, "shapeAttribute": { "description": "Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in smart storage.", "Indicates that the resource is in block storage." ], "enum": [ "SHAPE_ATTRIBUTE_UNSPECIFIED", "SMART_STORAGE", "BLOCK_STORAGE" ] }, "memorySizeGb": { "description": "Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs.", "readOnly": true, "type": "integer", "format": "int32" }, "scanListenerPortTcp": { "description": "Optional. Immutable. SCAN listener port - TCP", "type": "integer", "format": "int32" }, "ociUri": { "description": "Output only. Deep link to the OCI console to view this resource.", "readOnly": true, "type": "string" }, "giVersion": { "description": "Output only. The Oracle Grid Infrastructure (GI) software version.", "readOnly": true, "type": "string" } } }, "ExadbVmClusterStorageDetails": { "id": "ExadbVmClusterStorageDetails", "description": "The storage allocation for the exadbvmcluster, in gigabytes (GB).", "type": "object", "properties": { "sizeInGbsPerNode": { "description": "Required. The storage allocation for the exadbvmcluster per node, in gigabytes (GB). This field is used to calculate the total storage allocation for the exadbvmcluster.", "type": "integer", "format": "int32" } } }, "DataCollectionOptionsCommon": { "id": "DataCollectionOptionsCommon", "description": "Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions", "type": "object", "properties": { "isDiagnosticsEventsEnabled": { "description": "Optional. Indicates whether to enable data collection for diagnostics.", "type": "boolean" }, "isHealthMonitoringEnabled": { "description": "Optional. Indicates whether to enable health monitoring.", "type": "boolean" }, "isIncidentLogsEnabled": { "description": "Optional. Indicates whether to enable incident logs and trace collection.", "type": "boolean" } } }, "RemoveVirtualMachineExadbVmClusterRequest": { "id": "RemoveVirtualMachineExadbVmClusterRequest", "description": "The request for `ExadbVmCluster.RemoveVirtualMachine`.", "type": "object", "properties": { "requestId": { "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "hostnames": { "description": "Required. The list of host names of db nodes to be removed from the ExadbVmCluster.", "type": "array", "items": { "type": "string" } } } }, "ListExascaleDbStorageVaultsResponse": { "id": "ListExascaleDbStorageVaultsResponse", "description": "The response for `ExascaleDbStorageVault.List`.", "type": "object", "properties": { "exascaleDbStorageVaults": { "description": "The ExascaleDbStorageVaults.", "type": "array", "items": { "$ref": "ExascaleDbStorageVault" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return. If present, the next page token can be provided to a subsequent ListExascaleDbStorageVaults call to list the next page. If empty, there are no more pages.", "type": "string" }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "type": "array", "items": { "type": "string" } } } }, "ExascaleDbStorageVault": { "id": "ExascaleDbStorageVault", "description": "ExascaleDbStorageVault represents a storage vault exadb vm cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExascaleDbStorageVault/", "type": "object", "properties": { "name": { "description": "Identifier. The resource name of the ExascaleDbStorageVault. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}", "type": "string" }, "displayName": { "description": "Required. The display name for the ExascaleDbStorageVault. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.", "type": "string" }, "gcpOracleZone": { "description": "Optional. The GCP Oracle zone where Oracle ExascaleDbStorageVault is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", "type": "string" }, "properties": { "description": "Required. The properties of the ExascaleDbStorageVault.", "$ref": "ExascaleDbStorageVaultProperties" }, "createTime": { "description": "Output only. The date and time when the ExascaleDbStorageVault was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "entitlementId": { "description": "Output only. The ID of the subscription entitlement associated with the ExascaleDbStorageVault.", "readOnly": true, "type": "string" }, "labels": { "description": "Optional. The labels or tags associated with the ExascaleDbStorageVault.", "type": "object", "additionalProperties": { "type": "string" } }, "exadataInfrastructure": { "description": "Optional. The Exadata Infrastructure resource on which ExascaleDbStorageVault resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}", "type": "string" } } }, "ExascaleDbStorageVaultProperties": { "id": "ExascaleDbStorageVaultProperties", "description": "The properties of the ExascaleDbStorageVault. next ID: 12", "type": "object", "properties": { "ocid": { "description": "Output only. The OCID for the ExascaleDbStorageVault.", "readOnly": true, "type": "string" }, "timeZone": { "description": "Output only. The time zone of the ExascaleDbStorageVault.", "readOnly": true, "$ref": "TimeZone" }, "exascaleDbStorageDetails": { "description": "Required. The storage details of the ExascaleDbStorageVault.", "$ref": "ExascaleDbStorageDetails" }, "state": { "description": "Output only. The state of the ExascaleDbStorageVault.", "readOnly": true, "type": "string", "enumDescriptions": [ "The state of the ExascaleDbStorageVault is unspecified.", "The ExascaleDbStorageVault is being provisioned.", "The ExascaleDbStorageVault is available.", "The ExascaleDbStorageVault is being updated.", "The ExascaleDbStorageVault is being deleted.", "The ExascaleDbStorageVault has been deleted.", "The ExascaleDbStorageVault has failed." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED" ] }, "description": { "description": "Optional. The description of the ExascaleDbStorageVault.", "type": "string" }, "vmClusterIds": { "description": "Output only. The list of VM cluster OCIDs associated with the ExascaleDbStorageVault.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "vmClusterCount": { "description": "Output only. The number of VM clusters associated with the ExascaleDbStorageVault.", "readOnly": true, "type": "integer", "format": "int32" }, "additionalFlashCachePercent": { "description": "Optional. The size of additional flash cache in percentage of high capacity database storage.", "type": "integer", "format": "int32" }, "ociUri": { "description": "Output only. Deep link to the OCI console to view this resource.", "readOnly": true, "type": "string" }, "attachedShapeAttributes": { "description": "Output only. The shape attributes of the VM clusters attached to the ExascaleDbStorageVault.", "readOnly": true, "type": "array", "items": { "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in smart storage.", "Indicates that the resource is in block storage." ], "enum": [ "SHAPE_ATTRIBUTE_UNSPECIFIED", "SMART_STORAGE", "BLOCK_STORAGE" ] } }, "availableShapeAttributes": { "description": "Output only. The shape attributes available for the VM clusters to be attached to the ExascaleDbStorageVault.", "readOnly": true, "type": "array", "items": { "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in smart storage.", "Indicates that the resource is in block storage." ], "enum": [ "SHAPE_ATTRIBUTE_UNSPECIFIED", "SMART_STORAGE", "BLOCK_STORAGE" ] } } } }, "ExascaleDbStorageDetails": { "id": "ExascaleDbStorageDetails", "description": "The storage details of the ExascaleDbStorageVault.", "type": "object", "properties": { "availableSizeGbs": { "description": "Output only. The available storage capacity for the ExascaleDbStorageVault, in gigabytes (GB).", "readOnly": true, "type": "integer", "format": "int32" }, "totalSizeGbs": { "description": "Required. The total storage allocation for the ExascaleDbStorageVault, in gigabytes (GB).", "type": "integer", "format": "int32" } } }, "ListDbSystemInitialStorageSizesResponse": { "id": "ListDbSystemInitialStorageSizesResponse", "description": "The response for `DbSystemInitialStorageSizes.List`.", "type": "object", "properties": { "dbSystemInitialStorageSizes": { "description": "The list of DbSystemInitialStorageSizes.", "type": "array", "items": { "$ref": "DbSystemInitialStorageSize" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "DbSystemInitialStorageSize": { "id": "DbSystemInitialStorageSize", "description": "Summary of the DbSystem initial storage size.", "type": "object", "properties": { "name": { "description": "Output only. The name of the resource.", "readOnly": true, "type": "string" }, "properties": { "description": "Output only. The properties of the DbSystem initial storage size summary.", "readOnly": true, "$ref": "DbSystemInitialStorageSizeProperties" } } }, "DbSystemInitialStorageSizeProperties": { "id": "DbSystemInitialStorageSizeProperties", "description": "The properties of a DbSystem initial storage size summary.", "type": "object", "properties": { "storageManagement": { "description": "Output only. The storage option used in DB system.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified storage management.", "Automatic Storage Management.", "Logical Volume Management." ], "enum": [ "STORAGE_MANAGEMENT_UNSPECIFIED", "ASM", "LVM" ] }, "shapeType": { "description": "Output only. VM shape platform type", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified shape type.", "Standard X86." ], "enum": [ "SHAPE_TYPE_UNSPECIFIED", "STANDARD_X86" ] }, "storageSizeDetails": { "description": "Output only. List of storage disk details.", "readOnly": true, "type": "array", "items": { "$ref": "StorageSizeDetails" } }, "launchFromBackupStorageSizeDetails": { "description": "Output only. List of storage disk details available for launches from backup.", "readOnly": true, "type": "array", "items": { "$ref": "StorageSizeDetails" } } } }, "StorageSizeDetails": { "id": "StorageSizeDetails", "description": "The initial storage size, in gigabytes, that is applicable for virtual machine DBSystem.", "type": "object", "properties": { "dataStorageSizeInGbs": { "description": "Output only. The data storage size, in gigabytes, that is applicable for virtual machine DBSystem.", "readOnly": true, "type": "integer", "format": "int32" }, "recoStorageSizeInGbs": { "description": "Output only. The RECO/REDO storage size, in gigabytes, that is applicable for virtual machine DBSystem.", "readOnly": true, "type": "integer", "format": "int32" } } }, "ListDatabasesResponse": { "id": "ListDatabasesResponse", "description": "The response for `Database.List`.", "type": "object", "properties": { "databases": { "description": "The list of Databases.", "type": "array", "items": { "$ref": "Database" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "Database": { "id": "Database", "description": "Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}", "type": "string" }, "dbName": { "description": "Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.", "type": "string" }, "dbUniqueName": { "description": "Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.", "type": "string" }, "adminPassword": { "description": "Optional. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", "type": "string" }, "adminPasswordSecretVersion": { "description": "Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", "type": "string" }, "tdeWalletPassword": { "description": "Optional. The TDE wallet password for the database. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated.", "type": "string" }, "tdeWalletPasswordSecretVersion": { "description": "Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated.", "type": "string" }, "characterSet": { "description": "Optional. The character set for the database. The default is AL32UTF8.", "type": "string" }, "ncharacterSet": { "description": "Optional. The national character set for the database. The default is AL16UTF16.", "type": "string" }, "ociUrl": { "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The date and time that the Database was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "properties": { "description": "Optional. The properties of the Database.", "$ref": "DatabaseProperties" }, "databaseId": { "description": "Optional. The database ID of the Database.", "type": "string" }, "dbHomeName": { "description": "Optional. The name of the DbHome resource associated with the Database.", "type": "string" }, "gcpOracleZone": { "description": "Output only. The GCP Oracle zone where the Database is created.", "readOnly": true, "type": "string" }, "opsInsightsStatus": { "description": "Output only. The Status of Operations Insights for this Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the operations insights are being enabled.", "Indicates that the operations insights are enabled.", "Indicates that the operations insights are being disabled.", "Indicates that the operations insights are not enabled.", "Indicates that the operations insights failed to enable.", "Indicates that the operations insights failed to disable." ], "enum": [ "OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED", "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING" ] }, "pluggableDatabaseId": { "description": "Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location.", "type": "string" }, "pluggableDatabaseName": { "description": "Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters.", "type": "string" } } }, "DatabaseProperties": { "id": "DatabaseProperties", "description": "The properties of a Database.", "type": "object", "properties": { "state": { "description": "Output only. State of the Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in updating state.", "Indicates that the resource is in backup in progress state.", "Indicates that the resource is in upgrading state.", "Indicates that the resource is in converting state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", "Indicates that the resource is in restore failed state.", "Indicates that the resource is in failed state." ], "enum": [ "DATABASE_LIFECYCLE_STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "BACKUP_IN_PROGRESS", "UPGRADING", "CONVERTING", "TERMINATING", "TERMINATED", "RESTORE_FAILED", "FAILED" ] }, "dbVersion": { "description": "Required. The Oracle Database version.", "type": "string" }, "dbBackupConfig": { "description": "Optional. Backup options for the Database.", "$ref": "DbBackupConfig" }, "databaseManagementConfig": { "description": "Output only. The Database Management config.", "readOnly": true, "$ref": "DatabaseManagementConfig" } } }, "DbBackupConfig": { "id": "DbBackupConfig", "description": "Backup Options for the Database.", "type": "object", "properties": { "autoBackupEnabled": { "description": "Optional. If set to true, enables automatic backups on the database.", "type": "boolean" }, "backupDestinationDetails": { "description": "Optional. Details of the database backup destinations.", "type": "array", "items": { "$ref": "BackupDestinationDetails" } }, "retentionPeriodDays": { "description": "Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.", "type": "integer", "format": "int32" }, "backupDeletionPolicy": { "description": "Optional. This defines when the backups will be deleted after Database termination.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Keeps the backup for predefined time i.e. 72 hours and then delete permanently.", "Keeps the backups as per the policy defined for database backups." ], "enum": [ "BACKUP_DELETION_POLICY_UNSPECIFIED", "DELETE_IMMEDIATELY", "DELETE_AFTER_RETENTION_PERIOD" ] }, "autoFullBackupDay": { "description": "Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.", "type": "string", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "autoFullBackupWindow": { "description": "Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "12:00 AM - 2:00 AM", "2:00 AM - 4:00 AM", "4:00 AM - 6:00 AM", "6:00 AM - 8:00 AM", "8:00 AM - 10:00 AM", "10:00 AM - 12:00 PM", "12:00 PM - 2:00 PM", "2:00 PM - 4:00 PM", "4:00 PM - 6:00 PM", "6:00 PM - 8:00 PM", "8:00 PM - 10:00 PM", "10:00 PM - 12:00 AM" ], "enum": [ "BACKUP_WINDOW_UNSPECIFIED", "SLOT_ONE", "SLOT_TWO", "SLOT_THREE", "SLOT_FOUR", "SLOT_FIVE", "SLOT_SIX", "SLOT_SEVEN", "SLOT_EIGHT", "SLOT_NINE", "SLOT_TEN", "SLOT_ELEVEN", "SLOT_TWELVE" ] }, "autoIncrementalBackupWindow": { "description": "Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "12:00 AM - 2:00 AM", "2:00 AM - 4:00 AM", "4:00 AM - 6:00 AM", "6:00 AM - 8:00 AM", "8:00 AM - 10:00 AM", "10:00 AM - 12:00 PM", "12:00 PM - 2:00 PM", "2:00 PM - 4:00 PM", "4:00 PM - 6:00 PM", "6:00 PM - 8:00 PM", "8:00 PM - 10:00 PM", "10:00 PM - 12:00 AM" ], "enum": [ "BACKUP_WINDOW_UNSPECIFIED", "SLOT_ONE", "SLOT_TWO", "SLOT_THREE", "SLOT_FOUR", "SLOT_FIVE", "SLOT_SIX", "SLOT_SEVEN", "SLOT_EIGHT", "SLOT_NINE", "SLOT_TEN", "SLOT_ELEVEN", "SLOT_TWELVE" ] } } }, "BackupDestinationDetails": { "id": "BackupDestinationDetails", "description": "The details of the database backup destination.", "type": "object", "properties": { "type": { "description": "Optional. The type of the database backup destination.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Backup destination type is NFS.", "Backup destination type is Recovery Appliance.", "Backup destination type is Object Store.", "Backup destination type is Local.", "Backup destination type is DBRS." ], "enum": [ "BACKUP_DESTINATION_TYPE_UNSPECIFIED", "NFS", "RECOVERY_APPLIANCE", "OBJECT_STORE", "LOCAL", "DBRS" ] } } }, "DatabaseManagementConfig": { "id": "DatabaseManagementConfig", "description": "The configuration of the Database Management service.", "type": "object", "properties": { "managementState": { "description": "Output only. The status of the Database Management service.", "readOnly": true, "type": "string", "enumDescriptions": [ "The status is not specified.", "The Database Management service is enabling.", "The Database Management service is enabled.", "The Database Management service is disabling.", "The Database Management service is disabled.", "The Database Management service is updating.", "The Database Management service failed to enable.", "The Database Management service failed to disable.", "The Database Management service failed to update." ], "enum": [ "MANAGEMENT_STATE_UNSPECIFIED", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING", "FAILED_ENABLING", "FAILED_DISABLING", "FAILED_UPDATING" ] }, "managementType": { "description": "Output only. The Database Management type.", "readOnly": true, "type": "string", "enumDescriptions": [ "The type is not specified.", "Basic Database Management.", "Advanced Database Management." ], "enum": [ "MANAGEMENT_TYPE_UNSPECIFIED", "BASIC", "ADVANCED" ] } } }, "ListPluggableDatabasesResponse": { "id": "ListPluggableDatabasesResponse", "description": "The response for `PluggableDatabase.List`.", "type": "object", "properties": { "pluggableDatabases": { "description": "The list of PluggableDatabases.", "type": "array", "items": { "$ref": "PluggableDatabase" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "PluggableDatabase": { "id": "PluggableDatabase", "description": "The PluggableDatabase resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/PluggableDatabase/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}", "type": "string" }, "properties": { "description": "Optional. The properties of the PluggableDatabase.", "$ref": "PluggableDatabaseProperties" }, "ociUrl": { "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The date and time that the PluggableDatabase was created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "PluggableDatabaseProperties": { "id": "PluggableDatabaseProperties", "description": "The properties of a PluggableDatabase.", "type": "object", "properties": { "compartmentId": { "description": "Required. The OCID of the compartment.", "type": "string" }, "connectionStrings": { "description": "Optional. The Connection strings used to connect to the Oracle Database.", "$ref": "PluggableDatabaseConnectionStrings" }, "containerDatabaseOcid": { "description": "Required. The OCID of the CDB.", "type": "string" }, "definedTags": { "description": "Optional. Defined tags for this resource. Each key is predefined and scoped to a namespace.", "type": "object", "additionalProperties": { "$ref": "DefinedTagValue" } }, "freeformTags": { "description": "Optional. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.", "type": "object", "additionalProperties": { "type": "string" } }, "ocid": { "description": "Output only. The OCID of the pluggable database.", "readOnly": true, "type": "string" }, "isRestricted": { "description": "Optional. The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.", "type": "boolean" }, "lifecycleDetails": { "description": "Output only. Additional information about the current lifecycle state.", "readOnly": true, "type": "string" }, "lifecycleState": { "description": "Output only. The current state of the pluggable database.", "readOnly": true, "type": "string", "enumDescriptions": [ "The lifecycle state is unspecified.", "The pluggable database is provisioning.", "The pluggable database is available.", "The pluggable database is terminating.", "The pluggable database is terminated.", "The pluggable database is updating.", "The pluggable database is in a failed state.", "The pluggable database is relocating.", "The pluggable database is relocated.", "The pluggable database is refreshing.", "The pluggable database is restoring.", "The pluggable database restore failed.", "The pluggable database is backing up.", "The pluggable database is disabled." ], "enum": [ "PLUGGABLE_DATABASE_LIFECYCLE_STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED", "UPDATING", "FAILED", "RELOCATING", "RELOCATED", "REFRESHING", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "DISABLED" ] }, "pdbName": { "description": "Required. The database name.", "type": "string" }, "pdbNodeLevelDetails": { "description": "Optional. Pluggable Database Node Level Details", "type": "array", "items": { "$ref": "PluggableDatabaseNodeLevelDetails" } }, "databaseManagementConfig": { "description": "Output only. The configuration of the Database Management service.", "readOnly": true, "$ref": "DatabaseManagementConfig" }, "operationsInsightsState": { "description": "Output only. The status of Operations Insights for this Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "The status is not specified.", "Operations Insights is enabling.", "Operations Insights is enabled.", "Operations Insights is disabling.", "Operations Insights is not enabled.", "Operations Insights failed to enable.", "Operations Insights failed to disable." ], "enum": [ "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED", "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING" ] } } }, "PluggableDatabaseConnectionStrings": { "id": "PluggableDatabaseConnectionStrings", "description": "The connection strings used to connect to the Oracle Database.", "type": "object", "properties": { "allConnectionStrings": { "description": "Optional. All connection strings to use to connect to the pluggable database.", "type": "object", "additionalProperties": { "type": "string" } }, "pdbDefault": { "description": "Optional. The default connection string to use to connect to the pluggable database.", "type": "string" }, "pdbIpDefault": { "description": "Optional. The default connection string to use to connect to the pluggable database using IP.", "type": "string" } } }, "DefinedTagValue": { "id": "DefinedTagValue", "description": "Wrapper message for the value of a defined tag.", "type": "object", "properties": { "tags": { "description": "The tags within the namespace.", "type": "object", "additionalProperties": { "type": "string" } } } }, "PluggableDatabaseNodeLevelDetails": { "id": "PluggableDatabaseNodeLevelDetails", "description": "The Pluggable Database Node Level Details.", "type": "object", "properties": { "nodeName": { "description": "Required. The Node name of the Database home.", "type": "string" }, "openMode": { "description": "Required. The mode that the pluggable database is in to open it.", "type": "string", "enumDescriptions": [ "The open mode is unspecified.", "The pluggable database is opened in read-only mode.", "The pluggable database is opened in read-write mode.", "The pluggable database is mounted.", "The pluggable database is migrated." ], "enum": [ "PLUGGABLE_DATABASE_OPEN_MODE_UNSPECIFIED", "READ_ONLY", "READ_WRITE", "MOUNTED", "MIGRATE" ] }, "pluggableDatabaseId": { "description": "Required. The OCID of the Pluggable Database.", "type": "string" } } }, "ListDbSystemsResponse": { "id": "ListDbSystemsResponse", "description": "The response for `DbSystem.List`.", "type": "object", "properties": { "dbSystems": { "description": "The list of DbSystems.", "type": "array", "items": { "$ref": "DbSystem" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "type": "array", "items": { "type": "string" } } } }, "DbSystem": { "id": "DbSystem", "description": "Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/", "type": "object", "properties": { "name": { "description": "Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}", "type": "string" }, "properties": { "description": "Optional. The properties of the DbSystem.", "$ref": "DbSystemProperties" }, "gcpOracleZone": { "description": "Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", "type": "string" }, "labels": { "description": "Optional. The labels or tags associated with the DbSystem.", "type": "object", "additionalProperties": { "type": "string" } }, "odbNetwork": { "description": "Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", "type": "string" }, "odbSubnet": { "description": "Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "entitlementId": { "description": "Output only. The ID of the subscription entitlement associated with the DbSystem", "readOnly": true, "type": "string" }, "displayName": { "description": "Required. The display name for the System db. The name does not have to be unique within your project.", "type": "string" }, "createTime": { "description": "Output only. The date and time that the DbSystem was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "ociUrl": { "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", "readOnly": true, "type": "string" } } }, "DbSystemProperties": { "id": "DbSystemProperties", "description": "The properties of a DbSystem.", "type": "object", "properties": { "shape": { "description": "Required. Shape of DB System.", "type": "string" }, "computeCount": { "description": "Required. The number of CPU cores to enable for the DbSystem.", "type": "integer", "format": "int32" }, "initialDataStorageSizeGb": { "description": "Required. The initial data storage size in GB.", "type": "integer", "format": "int32" }, "databaseEdition": { "description": "Required. The database edition of the DbSystem.", "type": "string", "enumDescriptions": [ "The database edition is unspecified.", "The database edition is Standard.", "The database edition is Enterprise.", "The database edition is Enterprise Edition." ], "enum": [ "DB_SYSTEM_DATABASE_EDITION_UNSPECIFIED", "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE" ] }, "licenseModel": { "description": "Required. The license model of the DbSystem.", "type": "string", "enumDescriptions": [ "The license model is unspecified.", "The license model is included.", "The license model is bring your own license." ], "enum": [ "LICENSE_MODEL_UNSPECIFIED", "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" ] }, "sshPublicKeys": { "description": "Required. SSH public keys to be stored with the DbSystem.", "type": "array", "items": { "type": "string" } }, "hostnamePrefix": { "description": "Optional. Prefix for DB System host names.", "type": "string" }, "hostname": { "description": "Output only. The hostname of the DbSystem.", "readOnly": true, "type": "string" }, "privateIp": { "description": "Optional. The private IP address of the DbSystem.", "type": "string" }, "dataCollectionOptions": { "description": "Optional. Data collection options for diagnostics.", "$ref": "DataCollectionOptionsDbSystem" }, "timeZone": { "description": "Optional. Time zone of the DbSystem.", "$ref": "TimeZone" }, "lifecycleState": { "description": "Output only. State of the DbSystem.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in updating state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", "Indicates that the resource is in failed state.", "Indicates that the resource has been migrated.", "Indicates that the resource is in maintenance in progress state.", "Indicates that the resource needs attention.", "Indicates that the resource is upgrading." ], "enum": [ "DB_SYSTEM_LIFECYCLE_STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "MIGRATED", "MAINTENANCE_IN_PROGRESS", "NEEDS_ATTENTION", "UPGRADING" ] }, "dbHome": { "description": "Optional. Details for creating a Database Home.", "$ref": "DbHome" }, "ocid": { "description": "Output only. OCID of the DbSystem.", "readOnly": true, "type": "string" }, "memorySizeGb": { "description": "Optional. The memory size in GB.", "type": "integer", "format": "int32" }, "computeModel": { "description": "Optional. The compute model of the DbSystem.", "type": "string", "enumDescriptions": [ "The compute model is unspecified.", "The compute model is virtual.", "The compute model is physical." ], "enum": [ "COMPUTE_MODEL_UNSPECIFIED", "ECPU", "OCPU" ] }, "dataStorageSizeGb": { "description": "Optional. The data storage size in GB that is currently available to DbSystems.", "type": "integer", "format": "int32" }, "recoStorageSizeGb": { "description": "Optional. The reco/redo storage size in GB.", "type": "integer", "format": "int32" }, "domain": { "description": "Optional. The host domain name of the DbSystem.", "type": "string" }, "nodeCount": { "description": "Optional. The number of nodes in the DbSystem.", "type": "integer", "format": "int32" }, "dbSystemOptions": { "description": "Optional. The options for the DbSystem.", "$ref": "DbSystemOptions" } } }, "DataCollectionOptionsDbSystem": { "id": "DataCollectionOptionsDbSystem", "description": "Data collection options for DbSystem.", "type": "object", "properties": { "isDiagnosticsEventsEnabled": { "description": "Optional. Indicates whether to enable data collection for diagnostics.", "type": "boolean" }, "isIncidentLogsEnabled": { "description": "Optional. Indicates whether to enable incident logs and trace collection.", "type": "boolean" } } }, "DbHome": { "id": "DbHome", "description": "Details of the Database Home resource.", "type": "object", "properties": { "displayName": { "description": "Optional. The display name for the Database Home. The name does not have to be unique within your project.", "type": "string" }, "dbVersion": { "description": "Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.", "type": "string" }, "database": { "description": "Required. The Database resource.", "$ref": "Database" }, "isUnifiedAuditingEnabled": { "description": "Optional. Whether unified auditing is enabled for the Database Home.", "type": "boolean" } } }, "DbSystemOptions": { "id": "DbSystemOptions", "description": "Details of the DbSystem Options.", "type": "object", "properties": { "storageManagement": { "description": "Optional. The storage option used in DB system.", "type": "string", "enumDescriptions": [ "The storage management is unspecified.", "Automatic storage management. This option is not supported. Only LVM is supported.", "Logical Volume management." ], "enum": [ "STORAGE_MANAGEMENT_UNSPECIFIED", "ASM", "LVM" ] } } }, "ListGoldengateDeploymentsResponse": { "id": "ListGoldengateDeploymentsResponse", "description": "The response for `GoldengateDeployment.List`.", "type": "object", "properties": { "goldengateDeployments": { "description": "The list of GoldengateDeployments.", "type": "array", "items": { "$ref": "GoldengateDeployment" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Optional. Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "GoldengateDeployment": { "id": "GoldengateDeployment", "description": "GoldengateDeployment Goldengate Deployment resource model.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the GoldengateDeployment resource in the following format: projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment}", "type": "string" }, "properties": { "description": "Required. The properties of the GoldengateDeployment.", "$ref": "GoldengateDeploymentProperties" }, "gcpOracleZone": { "description": "Optional. The GCP Oracle zone where Oracle GoldengateDeployment is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", "type": "string" }, "labels": { "description": "Optional. The labels or tags associated with the GoldengateDeployment.", "type": "object", "additionalProperties": { "type": "string" } }, "odbNetwork": { "description": "Optional. The name of the OdbNetwork associated with the GoldengateDeployment.", "type": "string" }, "odbSubnet": { "description": "Required. The name of the OdbSubnet associated with the GoldengateDeployment for IP allocation.", "type": "string" }, "entitlementId": { "description": "Output only. The ID of the subscription entitlement associated with the GoldengateDeployment", "readOnly": true, "type": "string" }, "displayName": { "description": "Required. The display name for the GoldengateDeployment.", "type": "string" }, "createTime": { "description": "Output only. The date and time that the GoldengateDeployment was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "ociUrl": { "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", "readOnly": true, "type": "string" } } }, "GoldengateDeploymentProperties": { "id": "GoldengateDeploymentProperties", "description": "Properties of GoldengateDeployment.", "type": "object", "properties": { "ocid": { "description": "Output only. OCID of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "lifecycleState": { "description": "Output only. State of the GoldengateDeployment.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "The deployment is being created.", "The deployment is being updated.", "The deployment is active.", "The deployment is inactive.", "The deployment is being deleted.", "The deployment is deleted.", "The deployment failed.", "The deployment needs attention.", "The deployment is in progress.", "The deployment is canceling.", "The deployment is canceled.", "The deployment succeeded.", "The deployment is waiting." ], "enum": [ "GOLDENGATE_DEPLOYMENT_LIFECYCLE_STATE_UNSPECIFIED", "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED", "NEEDS_ATTENTION", "IN_PROGRESS", "CANCELLING", "CANCELLED", "SUCCEEDED", "WAITING" ] }, "licenseModel": { "description": "Optional. The Oracle license model that applies to a Deployment.", "type": "string", "enumDescriptions": [ "The license model is unspecified.", "The license model is included.", "The license model is bring your own license." ], "enum": [ "LICENSE_MODEL_UNSPECIFIED", "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" ] }, "environmentType": { "description": "Optional. The environment type of the GoldengateDeployment.", "type": "string" }, "cpuCoreCount": { "description": "Optional. The Minimum number of OCPUs to be made available for this Deployment.", "type": "integer", "format": "int32" }, "isAutoScalingEnabled": { "description": "Optional. Indicates if auto scaling is enabled for the Deployment's CPU core count.", "type": "boolean" }, "description": { "description": "Optional. The description of the GoldengateDeployment.", "type": "string" }, "deploymentType": { "description": "Required. A valid Goldengate Deployment type. For a list of supported types, use the `ListGoldengateDeploymentTypes` operation.", "type": "string" }, "oggData": { "description": "Required. The ogg data of the GoldengateDeployment.", "$ref": "GoldengateOggDeployment" }, "maintenanceWindow": { "description": "Optional. The maintenance window of the GoldengateDeployment.", "$ref": "GoldengateMaintenanceWindow" }, "maintenanceConfig": { "description": "Optional. The maintenance configuration of the GoldengateDeployment.", "$ref": "GoldengateMaintenanceConfig" }, "fqdn": { "description": "Output only. The Fully Qualified Domain Name of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "lifecycleSubState": { "description": "Output only. The lifecycle sub-state of the GoldengateDeployment.", "readOnly": true, "type": "string", "enumDescriptions": [ "The lifecycle sub-state is unspecified.", "The deployment is recovering.", "The deployment is starting.", "The deployment is stopping.", "The deployment is moving.", "The deployment is upgrading.", "The deployment is restoring.", "The deployment is backing up.", "The deployment is rolling back." ], "enum": [ "GOLDENGATE_DEPLOYMENT_LIFECYCLE_SUB_STATE_UNSPECIFIED", "RECOVERING", "STARTING", "STOPPING", "MOVING", "UPGRADING", "RESTORING", "BACKING_UP", "ROLLING_BACK" ] }, "category": { "description": "Output only. The category of the GoldengateDeployment.", "readOnly": true, "type": "string", "enumDescriptions": [ "The category is unspecified.", "The deployment is data replication.", "The deployment is data transforms." ], "enum": [ "GOLDENGATE_DEPLOYMENT_CATEGORY_UNSPECIFIED", "DATA_REPLICATION", "DATA_TRANSFORMS" ] }, "deploymentBackupId": { "description": "Output only. The deployment backup id of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "updateTime": { "description": "Output only. The time the GoldengateDeployment was updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "lifecycleDetails": { "description": "Output only. The lifecycle details of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "healthy": { "description": "Output only. Whether the GoldengateDeployment is healthy.", "readOnly": true, "type": "boolean" }, "loadBalancerSubnetId": { "description": "Output only. The load balancer subnet id of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "loadBalancerId": { "description": "Output only. The load balancer id of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "nsgIds": { "description": "Output only. The nsg ids of the GoldengateDeployment.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "isPublic": { "description": "Output only. Whether the GoldengateDeployment is public.", "readOnly": true, "type": "boolean" }, "publicIpAddress": { "description": "Output only. The public ip address of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "privateIpAddress": { "description": "Output only. The private ip address of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "deploymentUrl": { "description": "Output only. The deployment url of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "isLatestVersion": { "description": "Output only. Whether the GoldengateDeployment is of the latest version.", "readOnly": true, "type": "boolean" }, "upgradeRequiredTime": { "description": "Output only. The time upgrade required of the GoldengateDeployment.", "readOnly": true, "type": "string", "format": "google-datetime" }, "storageUtilizationBytes": { "description": "Output only. The storage utilization in bytes of the GoldengateDeployment.", "readOnly": true, "type": "string", "format": "int64" }, "isStorageUtilizationLimitExceeded": { "description": "Output only. Whether storage utilization limit is exceeded of the GoldengateDeployment.", "readOnly": true, "type": "boolean" }, "deploymentDiagnosticData": { "description": "Output only. The deployment diagnostic data of the GoldengateDeployment.", "readOnly": true, "$ref": "DeploymentDiagnosticData" }, "backupSchedule": { "description": "Output only. The backup schedule of the GoldengateDeployment.", "readOnly": true, "$ref": "GoldengateBackupSchedule" }, "nextMaintenanceTime": { "description": "Output only. The time of next maintenance of the GoldengateDeployment.", "readOnly": true, "type": "string", "format": "google-datetime" }, "nextMaintenanceActionType": { "description": "Output only. The next maintenance action type of the GoldengateDeployment.", "readOnly": true, "type": "string", "enumDescriptions": [ "The next maintenance action type is unspecified.", "The next maintenance action type is upgrade." ], "enum": [ "NEXT_MAINTENANCE_ACTION_TYPE_UNSPECIFIED", "UPGRADE" ] }, "nextMaintenanceDescription": { "description": "Output only. The next maintenance description of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "oggVersionSupportEndTime": { "description": "Output only. The time ogg version supported until of the GoldengateDeployment.", "readOnly": true, "type": "string", "format": "google-datetime" }, "ingressIps": { "description": "Output only. The ingress ips of the GoldengateDeployment.", "readOnly": true, "type": "array", "items": { "$ref": "IngressIp" } }, "deploymentRole": { "description": "Output only. The deployment role of the GoldengateDeployment.", "readOnly": true, "type": "string", "enumDescriptions": [ "The deployment role type is unspecified.", "The deployment role type is primary.", "The deployment role type is standby." ], "enum": [ "GOLDENGATE_DEPLOYMENT_ROLE_TYPE_UNSPECIFIED", "PRIMARY", "STANDBY" ] }, "lastBackupScheduleTime": { "description": "Output only. The time last backup scheduled of the GoldengateDeployment.", "readOnly": true, "type": "string", "format": "google-datetime" }, "nextBackupScheduleTime": { "description": "Output only. The time next backup scheduled of the GoldengateDeployment.", "readOnly": true, "type": "string", "format": "google-datetime" }, "roleChangeTime": { "description": "Output only. The time when the role of the GoldengateDeployment was changed.", "readOnly": true, "type": "string", "format": "google-datetime" }, "locks": { "description": "Output only. The locks of the GoldengateDeployment.", "readOnly": true, "type": "array", "items": { "$ref": "GoldengateDeploymentLock" } }, "placements": { "description": "Output only. The placements of the GoldengateDeployment.", "readOnly": true, "type": "array", "items": { "$ref": "GoldengatePlacement" } } } }, "GoldengateOggDeployment": { "id": "GoldengateOggDeployment", "description": "The Ogg data of the GoldengateDeployment.", "type": "object", "properties": { "adminPassword": { "description": "Optional. The Goldengate deployment console password in plain text.", "type": "string" }, "adminPasswordSecretVersion": { "description": "Optional. Input only. The Goldengate deployment console password secret version.", "type": "string" }, "deployment": { "description": "Required. The name given to the Goldengate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.", "type": "string" }, "adminUsername": { "description": "Required. The Goldengate deployment console username.", "type": "string" }, "oggVersion": { "description": "Optional. Version of OGG", "type": "string" }, "certificate": { "description": "Output only. The certificate of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "credentialStore": { "description": "Output only. The credential store of the GoldengateDeployment.", "readOnly": true, "type": "string", "enumDescriptions": [ "The credential store is unspecified.", "The credential store is Goldengate.", "The credential store is IAM." ], "enum": [ "CREDENTIAL_STORE_UNSPECIFIED", "GOLDENGATE", "IAM" ] }, "identityDomainId": { "description": "Output only. The identity domain id of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "passwordSecretId": { "description": "Output only. The password secret id of the GoldengateDeployment.", "readOnly": true, "type": "string" }, "groupRolesMapping": { "description": "Output only. The group to roles mapping of the GoldengateDeployment.", "readOnly": true, "$ref": "GoldengateGroupToRolesMapping" } } }, "GoldengateGroupToRolesMapping": { "id": "GoldengateGroupToRolesMapping", "description": "The group to roles mapping of the GoldengateDeployment.", "type": "object", "properties": { "securityGroupId": { "description": "Output only. The security group id.", "readOnly": true, "type": "string" }, "administratorGroupId": { "description": "Output only. The administrator group id.", "readOnly": true, "type": "string" }, "operatorGroupId": { "description": "Output only. The operator group id.", "readOnly": true, "type": "string" }, "userGroupId": { "description": "Output only. The user group id.", "readOnly": true, "type": "string" } } }, "GoldengateMaintenanceWindow": { "id": "GoldengateMaintenanceWindow", "description": "The maintenance window of the GoldengateDeployment.", "type": "object", "properties": { "day": { "description": "Required. Days of the week.", "type": "string", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "startHour": { "description": "Required. Start hour for maintenance period. Hour is in UTC.", "type": "integer", "format": "int32" } } }, "GoldengateMaintenanceConfig": { "id": "GoldengateMaintenanceConfig", "description": "The maintenance configuration of the GoldengateDeployment.", "type": "object", "properties": { "isInterimReleaseAutoUpgradeEnabled": { "description": "Optional. By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interim_release_upgrade_period_days too.", "type": "boolean" }, "interimReleaseUpgradePeriodDays": { "description": "Optional. Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.", "type": "integer", "format": "int32" }, "bundleReleaseUpgradePeriodDays": { "description": "Optional. Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.", "type": "integer", "format": "int32" }, "majorReleaseUpgradePeriodDays": { "description": "Optional. Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default.", "type": "integer", "format": "int32" }, "securityPatchUpgradePeriodDays": { "description": "Optional. Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default.", "type": "integer", "format": "int32" } } }, "DeploymentDiagnosticData": { "id": "DeploymentDiagnosticData", "description": "The deployment diagnostic data.", "type": "object", "properties": { "namespace": { "description": "Output only. The namespace name.", "readOnly": true, "type": "string" }, "bucket": { "description": "Output only. The bucket name.", "readOnly": true, "type": "string" }, "object": { "description": "Output only. The object name.", "readOnly": true, "type": "string" }, "diagnosticState": { "description": "Output only. The diagnostic state.", "readOnly": true, "type": "string", "enumDescriptions": [ "The diagnostic state is unspecified.", "The diagnostic is in progress.", "The diagnostic completed successfully.", "The diagnostic failed." ], "enum": [ "DIAGNOSTIC_STATE_UNSPECIFIED", "IN_PROGRESS", "SUCCEEDED", "FAILED" ] }, "diagnosticStartTime": { "description": "Output only. The time diagnostic start.", "readOnly": true, "type": "string", "format": "google-datetime" }, "diagnosticEndTime": { "description": "Output only. The time diagnostic end.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoldengateBackupSchedule": { "id": "GoldengateBackupSchedule", "description": "The backup schedule of the GoldengateDeployment.", "type": "object", "properties": { "bucket": { "description": "Output only. The bucket name.", "readOnly": true, "type": "string" }, "compartmentId": { "description": "Output only. The compartment id.", "readOnly": true, "type": "string" }, "frequencyBackupScheduled": { "description": "Output only. The frequency backup scheduled.", "readOnly": true, "type": "string", "enumDescriptions": [ "The frequency backup scheduled is unspecified.", "The frequency backup scheduled is daily.", "The frequency backup scheduled is weekly.", "The frequency backup scheduled is monthly." ], "enum": [ "FREQUENCY_BACKUP_SCHEDULED_UNSPECIFIED", "DAILY", "WEEKLY", "MONTHLY" ] }, "metadataOnly": { "description": "Output only. If metadata only.", "readOnly": true, "type": "boolean" }, "namespace": { "description": "Output only. The namespace name.", "readOnly": true, "type": "string" }, "backupScheduledTime": { "description": "Output only. The timestamp of when the backup was scheduled.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "IngressIp": { "id": "IngressIp", "description": "The ingress IPs of the GoldengateDeployment.", "type": "object", "properties": { "ingressIpAddress": { "description": "Output only. The ingress IP.", "readOnly": true, "type": "string" } } }, "GoldengateDeploymentLock": { "id": "GoldengateDeploymentLock", "description": "The lock of the GoldengateDeployment.", "type": "object", "properties": { "type": { "description": "Output only. The type of lock.", "readOnly": true, "type": "string", "enumDescriptions": [ "The lock type is unspecified.", "The lock type is full.", "The lock type is delete." ], "enum": [ "LOCK_TYPE_UNSPECIFIED", "FULL", "DELETE" ] }, "compartmentId": { "description": "Output only. The compartment id.", "readOnly": true, "type": "string" }, "relatedResourceId": { "description": "Output only. The related resource id.", "readOnly": true, "type": "string" }, "message": { "description": "Output only. The message.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The time created.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "GoldengatePlacement": { "id": "GoldengatePlacement", "description": "The placement of the GoldengateDeployment.", "type": "object", "properties": { "availabilityDomain": { "description": "Output only. The availability domain.", "readOnly": true, "type": "string" }, "faultDomain": { "description": "Output only. The fault domain.", "readOnly": true, "type": "string" } } }, "StopGoldengateDeploymentRequest": { "id": "StopGoldengateDeploymentRequest", "description": "The request for `GoldengateDeployment.Stop`.", "type": "object", "properties": {} }, "StartGoldengateDeploymentRequest": { "id": "StartGoldengateDeploymentRequest", "description": "The request for `GoldengateDeployment.Start`.", "type": "object", "properties": {} }, "ListGoldengateConnectionsResponse": { "id": "ListGoldengateConnectionsResponse", "description": "The response for `GoldengateConnection.List`.", "type": "object", "properties": { "goldengateConnections": { "description": "The list of GoldengateConnections.", "type": "array", "items": { "$ref": "GoldengateConnection" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Optional. Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "GoldengateConnection": { "id": "GoldengateConnection", "description": "Details of the GoldengateConnection resource.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the GoldengateConnection resource in the following format: projects/{project}/locations/{region}/goldengateConnections/{goldengate_connection}", "type": "string" }, "properties": { "description": "Required. The properties of the GoldengateConnection.", "$ref": "GoldengateConnectionProperties" }, "gcpOracleZone": { "description": "Optional. The GCP Oracle zone where Oracle GoldengateConnection is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", "type": "string" }, "labels": { "description": "Optional. The labels or tags associated with the GoldengateConnection.", "type": "object", "additionalProperties": { "type": "string" } }, "odbNetwork": { "description": "Optional. The name of the OdbNetwork associated with the GoldengateConnection. The format is projects/{project}/locations/{location}/odbNetworks/{odb_network}. It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", "type": "string" }, "odbSubnet": { "description": "Optional. The name of the OdbSubnet associated with the GoldengateConnection for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "entitlementId": { "description": "Output only. The ID of the subscription entitlement associated with the GoldengateConnection.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The date and time that the GoldengateConnection was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "ociUrl": { "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.", "readOnly": true, "type": "string" } } }, "GoldengateConnectionProperties": { "id": "GoldengateConnectionProperties", "description": "The properties of a GoldengateConnection.", "type": "object", "properties": { "oracleConnectionProperties": { "description": "Properties for an Oracle Database Connection.", "$ref": "GoldengateOracleConnectionProperties" }, "goldengateConnectionProperties": { "description": "Properties for a Goldengate Connection.", "$ref": "GoldengateGoldengateConnectionProperties" }, "genericConnectionProperties": { "description": "Properties for a Generic Connection.", "$ref": "GoldengateGenericConnectionProperties" }, "googleCloudStorageConnectionProperties": { "description": "Properties for a Google Cloud Storage Connection.", "$ref": "GoldengateGoogleCloudStorageConnectionProperties" }, "googleBigQueryConnectionProperties": { "description": "Properties for a Google BigQuery Connection.", "$ref": "GoldengateGoogleBigQueryConnectionProperties" }, "mysqlConnectionProperties": { "description": "Properties for a Mysql Connection.", "$ref": "GoldengateMysqlConnectionProperties" }, "kafkaConnectionProperties": { "description": "Properties for a Kafka Connection.", "$ref": "GoldengateKafkaConnectionProperties" }, "kafkaSchemaRegistryConnectionProperties": { "description": "Properties for a Kafka Schema Registry Connection.", "$ref": "GoldengateKafkaSchemaRegistryConnectionProperties" }, "ociObjectStorageConnectionProperties": { "description": "Properties for an OCI Object Storage Connection.", "$ref": "GoldengateOciObjectStorageConnectionProperties" }, "azureDataLakeStorageConnectionProperties": { "description": "Properties for an Azure Data Lake Storage Connection.", "$ref": "GoldengateAzureDataLakeStorageConnectionProperties" }, "azureSynapseAnalyticsConnectionProperties": { "description": "Properties for an Azure Synapse Analytics connection.", "$ref": "GoldengateAzureSynapseAnalyticsConnectionProperties" }, "postgresqlConnectionProperties": { "description": "Properties for a PostgreSQL connection.", "$ref": "GoldengatePostgresqlConnectionProperties" }, "microsoftSqlserverConnectionProperties": { "description": "Properties for a Microsoft SQL Server connection.", "$ref": "GoldengateMicrosoftSqlserverConnectionProperties" }, "amazonS3ConnectionProperties": { "description": "Properties for an Amazon S3 connection.", "$ref": "GoldengateAmazonS3ConnectionProperties" }, "hdfsConnectionProperties": { "description": "Properties for an HDFS connection.", "$ref": "GoldengateHdfsConnectionProperties" }, "javaMessageServiceConnectionProperties": { "description": "Properties for a Java Message Service connection.", "$ref": "GoldengateJavaMessageServiceConnectionProperties" }, "mongodbConnectionProperties": { "description": "Properties for a MongoDB connection.", "$ref": "GoldengateMongodbConnectionProperties" }, "oracleNosqlConnectionProperties": { "description": "Properties for an Oracle NoSQL connection.", "$ref": "GoldengateOracleNosqlConnectionProperties" }, "snowflakeConnectionProperties": { "description": "Properties for a Snowflake connection.", "$ref": "GoldengateSnowflakeConnectionProperties" }, "amazonRedshiftConnectionProperties": { "description": "Properties for an Amazon Redshift connection.", "$ref": "GoldengateAmazonRedshiftConnectionProperties" }, "elasticsearchConnectionProperties": { "description": "Properties for an Elasticsearch connection.", "$ref": "GoldengateElasticsearchConnectionProperties" }, "amazonKinesisConnectionProperties": { "description": "Properties for an Amazon Kinesis connection.", "$ref": "GoldengateAmazonKinesisConnectionProperties" }, "db2ConnectionProperties": { "description": "Properties for a DB2 connection.", "$ref": "GoldengateDb2ConnectionProperties" }, "redisConnectionProperties": { "description": "Properties for a Redis connection.", "$ref": "GoldengateRedisConnectionProperties" }, "databricksConnectionProperties": { "description": "Properties for a Databricks connection.", "$ref": "GoldengateDatabricksConnectionProperties" }, "googlePubsubConnectionProperties": { "description": "Properties for a Google Pub/Sub connection.", "$ref": "GoldengateGooglePubsubConnectionProperties" }, "microsoftFabricConnectionProperties": { "description": "Properties for a Microsoft Fabric connection.", "$ref": "GoldengateMicrosoftFabricConnectionProperties" }, "oracleAiDataPlatformConnectionProperties": { "description": "Properties for an Oracle AI Data Platform connection.", "$ref": "GoldengateOracleAIDataPlatformConnectionProperties" }, "icebergConnectionProperties": { "description": "Properties for an Iceberg connection.", "$ref": "GoldengateIcebergConnectionProperties" }, "connectionType": { "description": "Required. The connection type.", "type": "string", "enumDescriptions": [ "Connection type unspecified.", "Goldengate connection type.", "Kafka connection type.", "Kafka schema registry connection type.", "MySQL connection type.", "Java message service connection type.", "Microsoft SQL Server connection type.", "OCI object storage connection type.", "Oracle connection type.", "Azure data lake storage connection type.", "PostgreSQL connection type.", "Azure synapse analytics connection type.", "Snowflake connection type.", "Amazon S3 connection type.", "HDFS connection type.", "Oracle AI data platform connection type.", "Oracle NoSQL connection type.", "MongoDB connection type.", "Amazon Kinesis connection type.", "Amazon Redshift connection type.", "DB2 connection type.", "Redis connection type.", "Elasticsearch connection type.", "Generic connection type.", "Google Cloud Storage connection type.", "Google BigQuery connection type.", "Databricks connection type.", "Google Pub/Sub connection type.", "Microsoft Fabric connection type.", "Iceberg connection type." ], "enum": [ "GOLDENGATE_CONNECTION_TYPE_UNSPECIFIED", "GOLDENGATE", "KAFKA", "KAFKA_SCHEMA_REGISTRY", "MYSQL", "JAVA_MESSAGE_SERVICE", "MICROSOFT_SQLSERVER", "OCI_OBJECT_STORAGE", "ORACLE", "AZURE_DATA_LAKE_STORAGE", "POSTGRESQL", "AZURE_SYNAPSE_ANALYTICS", "SNOWFLAKE", "AMAZON_S3", "HDFS", "ORACLE_AI_DATA_PLATFORM", "ORACLE_NOSQL", "MONGODB", "AMAZON_KINESIS", "AMAZON_REDSHIFT", "DB2", "REDIS", "ELASTICSEARCH", "GENERIC", "GOOGLE_CLOUD_STORAGE", "GOOGLE_BIGQUERY", "DATABRICKS", "GOOGLE_PUBSUB", "MICROSOFT_FABRIC", "ICEBERG" ] }, "ocid": { "description": "Output only. The [OCID] of the connection being referenced.", "readOnly": true, "type": "string" }, "displayName": { "description": "Required. An object's Display Name.", "type": "string" }, "description": { "description": "Optional. Metadata about this specific object.", "type": "string" }, "lifecycleState": { "description": "Output only. The lifecycle state of the connection.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in active state.", "Indicates that the resource is in updating state.", "Indicates that the resource is in deleting state.", "Indicates that the resource is in deleted state.", "Indicates that the resource is in failed state." ], "enum": [ "GOLDENGATE_CONNECTION_LIFECYCLE_STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" ] }, "lifecycleDetails": { "description": "Output only. Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.", "readOnly": true, "type": "string" }, "updateTime": { "description": "Output only. The time the resource was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "routingMethod": { "description": "Optional. The routing method for the GoldengateConnection.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet.", "A dedicated private endpoint is created in the target VCN subnet for the connection." ], "enum": [ "GOLDENGATE_CONNECTION_ROUTING_METHOD_UNSPECIFIED", "SHARED_DEPLOYMENT_ENDPOINT", "DEDICATED_ENDPOINT" ] }, "ingressIpAddresses": { "description": "Output only. The Ingress IPs of the GoldengateConnection.", "readOnly": true, "type": "array", "items": { "type": "string" } } } }, "GoldengateOracleConnectionProperties": { "id": "GoldengateOracleConnectionProperties", "description": "The properties of Goldengate Oracle Database Connection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type.", "type": "string" }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect.", "type": "string" }, "authenticationMode": { "description": "Optional. Authentication mode.", "type": "string", "enumDescriptions": [ "Authentication mode not specified.", "TLS authentication mode.", "MTLS authentication mode." ], "enum": [ "ORACLE_AUTHENTICATION_MODE_UNSPECIFIED", "TLS", "MTLS" ] }, "connectionString": { "description": "Optional. Connect descriptor or Easy Connect Naming method used to connect to a database.", "type": "string" }, "sessionMode": { "description": "Optional. The mode of the database connection session to be established by the data client.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is using direct session mode.", "Indicates that the resource is using redirect session mode." ], "enum": [ "SESSION_MODE_UNSPECIFIED", "DIRECT", "REDIRECT" ] }, "gcpOracleDatabaseId": { "description": "Optional. Autonomous AI Database instance id of database in Oracle Database @ Google Cloud. If gcp_oracle_database_id is provided, connection_string must be empty. Format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}", "type": "string" }, "walletFile": { "description": "Optional. The wallet contents Oracle Goldengate uses to make connections to a database. This attribute is expected to be base64 encoded.", "type": "string" } } }, "GoldengateGoldengateConnectionProperties": { "id": "GoldengateGoldengateConnectionProperties", "description": "The properties of GoldengateGoldengateConnectionProperties.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password used to connect to the Oracle Goldengate in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password used to connect to the Oracle Goldengate. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type.", "type": "string" }, "goldengateDeploymentId": { "description": "Optional. The name of the GoldengateDeployment associated with the GoldengateConnection. Format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}", "type": "string" }, "host": { "description": "Optional. The host of the GoldengateConnection.", "type": "string" }, "port": { "description": "Optional. The port of the GoldengateConnection.", "type": "integer", "format": "int32" }, "username": { "description": "Optional. The username credential.", "type": "string" } } }, "GoldengateGenericConnectionProperties": { "id": "GoldengateGenericConnectionProperties", "description": "The properties of GoldengateGenericConnectionProperties.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type.", "type": "string" }, "host": { "description": "Optional. The host of the GenericConnection.", "type": "string" } } }, "GoldengateGoogleCloudStorageConnectionProperties": { "id": "GoldengateGoogleCloudStorageConnectionProperties", "description": "The properties of GoldengateGoogleCloudStorageConnectionProperties.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type.", "type": "string" }, "serviceAccountKeyFile": { "description": "Optional. The base64 encoded content of the service account key file containing the credentials required to use Google Cloud Storage.", "type": "string" } } }, "GoldengateGoogleBigQueryConnectionProperties": { "id": "GoldengateGoogleBigQueryConnectionProperties", "description": "The properties of GoldengateGoogleBigQueryConnectionProperties.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type.", "type": "string" }, "serviceAccountKeyFile": { "description": "Optional. The base64 encoded content of the service account key file containing the credentials required to use Google BigQuery.", "type": "string" } } }, "GoldengateMysqlConnectionProperties": { "id": "GoldengateMysqlConnectionProperties", "description": "Properties of GoldengateMysqlConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses to connect to MySQL in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to MySQL. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of MysqlConnection.", "type": "string" }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", "type": "string" }, "host": { "description": "Optional. The name or address of a host.", "type": "string" }, "port": { "description": "Optional. The port of an endpoint usually specified for a connection.", "type": "integer", "format": "int32" }, "database": { "description": "Optional. The name of the database.", "type": "string" }, "securityProtocol": { "description": "Optional. Security Type for MySQL.", "type": "string", "enumDescriptions": [ "Security type not specified.", "Plain text communication.", "Transport Layer Security.", "Mutual Transport Layer Security." ], "enum": [ "MYSQL_SECURITY_PROTOCOL_UNSPECIFIED", "PLAIN", "TLS", "MTLS" ] }, "sslMode": { "description": "Optional. SSL modes for MySQL.", "type": "string", "enumDescriptions": [ "SSL mode not specified.", "SSL is disabled.", "SSL is preferred.", "SSL is required.", "SSL is required and certificate is verified.", "SSL is required and certificate and hostname are verified." ], "enum": [ "SSL_MODE_UNSPECIFIED", "DISABLED", "PREFERRED", "REQUIRED", "VERIFY_CA", "VERIFY_IDENTITY" ] }, "sslCaFile": { "description": "Optional. Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL).", "type": "string" }, "sslCrlFile": { "description": "Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).", "type": "string" }, "sslCertFile": { "description": "Optional. Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL).", "type": "string" }, "sslKeyFile": { "description": "Optional. Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL).", "type": "string" }, "additionalAttributes": { "description": "Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string.", "type": "array", "items": { "$ref": "NameValuePair" } }, "dbSystemId": { "description": "Optional. The OCID of the database system being referenced.", "type": "string" } } }, "NameValuePair": { "id": "NameValuePair", "description": "A name-value pair representing an attribute entry usable in a list of attributes.", "type": "object", "properties": { "key": { "description": "Required. The name of the property entry.", "type": "string" }, "value": { "description": "Required. The value of the property entry.", "type": "string" } } }, "GoldengateKafkaConnectionProperties": { "id": "GoldengateKafkaConnectionProperties", "description": "The properties of GoldengateKafkaConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password for Kafka basic/SASL auth in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for Kafka basic/SASL auth. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "trustStorePassword": { "description": "Optional. Input only. The TrustStore password in plain text.", "type": "string" }, "trustStorePasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "keyStorePassword": { "description": "Optional. Input only. The KeyStore password in plain text.", "type": "string" }, "keyStorePasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "sslKeyPassword": { "description": "Optional. Input only. The password for the cert inside of the KeyStore in plain text.", "type": "string" }, "sslKeyPasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of KafkaConnection.", "type": "string" }, "streamPoolId": { "description": "Optional. The OCID of the stream pool being referenced.", "type": "string" }, "clusterId": { "description": "Optional. The OCID of the Kafka cluster being referenced from OCI Streaming with Apache Kafka.", "type": "string" }, "bootstrapServers": { "description": "Optional. Kafka bootstrap. Equivalent of bootstrap.servers configuration property in Kafka: list of KafkaBootstrapServer objects specified by host/port. Used for establishing the initial connection to the Kafka cluster. Example: \"server1.example.com:9092,server2.example.com:9092\"", "type": "array", "items": { "$ref": "KafkaBootstrapServer" } }, "securityProtocol": { "description": "Optional. Security Type for Kafka.", "type": "string", "enumDescriptions": [ "Security type not specified.", "SSL security protocol.", "SASL SSL security protocol.", "Plaintext security protocol.", "SASL Plaintext security protocol." ], "enum": [ "KAFKA_SECURITY_PROTOCOL_UNSPECIFIED", "SSL", "SASL_SSL", "PLAINTEXT", "SASL_PLAINTEXT" ] }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", "type": "string" }, "trustStoreFile": { "description": "Optional. The base64 encoded content of the TrustStore file.", "type": "string" }, "keyStoreFile": { "description": "Optional. The base64 encoded content of the KeyStore file.", "type": "string" }, "consumerPropertiesFile": { "description": "Optional. The base64 encoded content of the consumer.properties file.", "type": "string" }, "producerPropertiesFile": { "description": "Optional. The base64 encoded content of the producer.properties file.", "type": "string" }, "useResourcePrincipal": { "description": "Optional. Specifies that the user intends to authenticate to the instance using a resource principal. Applicable only for OCI Streaming connections.", "type": "boolean" } } }, "KafkaBootstrapServer": { "id": "KafkaBootstrapServer", "description": "Represents a Kafka bootstrap server with host name, optional port defaults to 9092, and an optional private ip.", "type": "object", "properties": { "host": { "description": "Required. The name or address of a host.", "type": "string" }, "port": { "description": "Optional. The port of an endpoint usually specified for a connection.", "type": "integer", "format": "int32" }, "privateIpAddress": { "description": "Optional. The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.", "type": "string" } } }, "GoldengateKafkaSchemaRegistryConnectionProperties": { "id": "GoldengateKafkaSchemaRegistryConnectionProperties", "description": "The properties of GoldengateKafkaSchemaRegistryConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password to access Schema Registry in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password to access Schema Registry using basic authentication. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "trustStorePassword": { "description": "Optional. Input only. The TrustStore password in plain text.", "type": "string" }, "trustStorePasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "keyStorePassword": { "description": "Optional. Input only. The KeyStore password in plain text.", "type": "string" }, "keyStorePasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "sslKeyPassword": { "description": "Optional. Input only. The password for the cert inside the KeyStore in plain text.", "type": "string" }, "sslKeyPasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of KafkaSchemaRegistryConnection.", "type": "string" }, "url": { "description": "Optional. Kafka Schema Registry URL. e.g.: 'https://server1.us.oracle.com:8081'", "type": "string" }, "authenticationType": { "description": "Optional. Used authentication mechanism to access Schema Registry.", "type": "string", "enumDescriptions": [ "Authentication type not specified.", "No authentication.", "Basic authentication.", "Mutual authentication." ], "enum": [ "AUTHENTICATION_TYPE_UNSPECIFIED", "NONE", "BASIC", "MUTUAL" ] }, "username": { "description": "Optional. The username to access Schema Registry using basic authentication. This value is injected into 'schema.registry.basic.auth.user.info=user:password' configuration property.", "type": "string" }, "trustStoreFile": { "description": "Optional. The base64 encoded content of the TrustStore file.", "type": "string" }, "keyStoreFile": { "description": "Optional. The base64 encoded content of the KeyStore file.", "type": "string" } } }, "GoldengateOciObjectStorageConnectionProperties": { "id": "GoldengateOciObjectStorageConnectionProperties", "description": "The properties of GoldengateOciObjectStorageConnection.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type of OciObjectStorageConnection.", "type": "string" }, "tenancyId": { "description": "Optional. The OCID of the related OCI tenancy.", "type": "string" }, "region": { "description": "Optional. The name of the region of OCI Object Storage. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.", "type": "string" }, "userId": { "description": "Optional. The OCID of the OCI user who will access the Object Storage. The user must have write access to the bucket they want to connect to.", "type": "string" }, "privateKeyFile": { "description": "Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint.", "type": "string" }, "privateKeyPassphraseSecret": { "description": "Optional. The passphrase of the private key.", "type": "string" }, "publicKeyFingerprint": { "description": "Optional. The fingerprint of the API Key of the user specified by the userId.", "type": "string" }, "useResourcePrincipal": { "description": "Optional. Specifies that the user intends to authenticate to the instance using a resource principal.", "type": "boolean" } } }, "GoldengateAzureDataLakeStorageConnectionProperties": { "id": "GoldengateAzureDataLakeStorageConnectionProperties", "description": "The properties of GoldengateAzureDataLakeStorageConnection.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type of AzureDataLakeStorageConnection.", "type": "string" }, "authenticationType": { "description": "Optional. Authentication mechanism to access Azure Data Lake Storage.", "type": "string", "enumDescriptions": [ "Authentication type not specified.", "Shared key authentication.", "Shared access signature authentication.", "Azure active directory authentication." ], "enum": [ "AUTHENTICATION_TYPE_UNSPECIFIED", "SHARED_KEY", "SHARED_ACCESS_SIGNATURE", "AZURE_ACTIVE_DIRECTORY" ] }, "account": { "description": "Optional. Sets the Azure storage account name.", "type": "string" }, "accountKeySecret": { "description": "Optional. Azure storage account key. This property is required when 'authentication_type' is set to 'SHARED_KEY'.", "type": "string" }, "sasTokenSecret": { "description": "Optional. Credential that uses a shared access signature (SAS) to authenticate to an Azure Service.", "type": "string" }, "azureTenantId": { "description": "Optional. Azure tenant ID of the application. This property is required when 'authentication_type' is set to 'AZURE_ACTIVE_DIRECTORY'.", "type": "string" }, "clientId": { "description": "Optional. Azure client ID of the application. This property is required when 'authentication_type' is set to 'AZURE_ACTIVE_DIRECTORY'.", "type": "string" }, "clientSecret": { "description": "Optional. Azure client secret (aka application password) for authentication.", "type": "string" }, "endpoint": { "description": "Optional. Azure Storage service endpoint. e.g: https://test.blob.core.windows.net", "type": "string" }, "azureAuthorityHost": { "description": "Optional. The endpoint used for authentication with Microsoft Entra ID (formerly Azure Active Directory). Default value: https://login.microsoftonline.com", "type": "string" } } }, "GoldengateAzureSynapseAnalyticsConnectionProperties": { "id": "GoldengateAzureSynapseAnalyticsConnectionProperties", "description": "The properties of GoldengateAzureSynapseAnalyticsConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses for Azure Synapse Analytics connection in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Azure Synapse Analytics connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of AzureSynapseAnalyticsConnection.", "type": "string" }, "connectionString": { "description": "Optional. JDBC connection string. e.g.: 'jdbc:sqlserver://.sql.azuresynapse.net:1433;database=;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.sql.azuresynapse.net;loginTimeout=300;'", "type": "string" }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", "type": "string" } } }, "GoldengatePostgresqlConnectionProperties": { "id": "GoldengatePostgresqlConnectionProperties", "description": "The properties of GoldengatePostgresqlConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses for PostgreSQL connection in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for PostgreSQL connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of PostgresqlConnection.", "type": "string" }, "database": { "description": "Optional. The name of the database.", "type": "string" }, "host": { "description": "Optional. The name or address of a host.", "type": "string" }, "port": { "description": "Optional. The port of an endpoint usually specified for a connection.", "type": "integer", "format": "int32" }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", "type": "string" }, "additionalAttributes": { "description": "Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string.", "type": "array", "items": { "$ref": "NameValuePair" } }, "securityProtocol": { "description": "Optional. Security protocol for PostgreSQL.", "type": "string", "enumDescriptions": [ "Security protocol not specified.", "Plain text communication.", "Transport Layer Security.", "Mutual Transport Layer Security." ], "enum": [ "POSTGRESQL_SECURITY_PROTOCOL_UNSPECIFIED", "PLAIN", "TLS", "MTLS" ] }, "sslMode": { "description": "Optional. SSL modes for PostgreSQL.", "type": "string", "enumDescriptions": [ "SSL mode not specified.", "Prefer SSL.", "Require SSL.", "Verify Certificate Authority.", "Verify Full." ], "enum": [ "POSTGRESQL_SSL_MODE_UNSPECIFIED", "PREFER", "REQUIRE", "VERIFY_CA", "VERIFY_FULL" ] }, "sslCaFile": { "description": "Optional. The base64 encoded certificate of the trusted certificate authorities (Trusted CA) for PostgreSQL.", "type": "string" }, "sslCrlFile": { "description": "Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).", "type": "string" }, "sslCertFile": { "description": "Optional. The base64 encoded certificate of the PostgreSQL server.", "type": "string" }, "sslKeyFile": { "description": "Optional. The base64 encoded private key of the PostgreSQL server.", "type": "string" }, "dbSystemId": { "description": "Optional. The OCID of the database system being referenced.", "type": "string" } } }, "GoldengateMicrosoftSqlserverConnectionProperties": { "id": "GoldengateMicrosoftSqlserverConnectionProperties", "description": "The properties of GoldengateMicrosoftSqlserverConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses for Microsoft SQL Server connection in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Microsoft SQL Server connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of MicrosoftSqlserverConnection.", "type": "string" }, "database": { "description": "Optional. The name of the database.", "type": "string" }, "host": { "description": "Optional. The name or address of a host.", "type": "string" }, "port": { "description": "Optional. The port of an endpoint usually specified for a connection.", "type": "integer", "format": "int32" }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect to the Microsoft SQL Server.", "type": "string" }, "additionalAttributes": { "description": "Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string.", "type": "array", "items": { "$ref": "NameValuePair" } }, "securityProtocol": { "description": "Optional. Security Type for Microsoft SQL Server.", "type": "string", "enumDescriptions": [ "Security type not specified.", "Plain text communication.", "Transport Layer Security." ], "enum": [ "MICROSOFT_SQLSERVER_SECURITY_PROTOCOL_UNSPECIFIED", "PLAIN", "TLS" ] }, "sslCaFile": { "description": "Optional. Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1-way SSL).", "type": "string" }, "serverCertificateValidationRequired": { "description": "Optional. If set to true, the driver validates the certificate that is sent by the database server.", "type": "boolean" } } }, "GoldengateAmazonS3ConnectionProperties": { "id": "GoldengateAmazonS3ConnectionProperties", "description": "The properties of GoldengateAmazonS3Connection.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type of AmazonS3Connection.", "type": "string" }, "accessKeyId": { "description": "Optional. Access key ID to access the Amazon S3 bucket.", "type": "string" }, "secretAccessKeySecret": { "description": "Optional. Secret access key to access the Amazon S3 bucket.", "type": "string" }, "endpoint": { "description": "Optional. The Amazon Endpoint for S3.", "type": "string" }, "region": { "description": "Optional. The name of the AWS region where the bucket is created.", "type": "string" } } }, "GoldengateHdfsConnectionProperties": { "id": "GoldengateHdfsConnectionProperties", "description": "The properties of GoldengateHdfsConnection.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type of HdfsConnection.", "type": "string" }, "coreSiteXml": { "description": "Optional. The content of the Hadoop Distributed File System configuration file (core-site.xml).", "type": "string" } } }, "GoldengateJavaMessageServiceConnectionProperties": { "id": "GoldengateJavaMessageServiceConnectionProperties", "description": "The properties of GoldengateJavaMessageServiceConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses to connect the Java Message Service in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the associated Java Message Service. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "trustStorePassword": { "description": "Optional. Input only. The TrustStore password in plain text.", "type": "string" }, "trustStorePasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "keyStorePassword": { "description": "Optional. Input only. The KeyStore password in plain text.", "type": "string" }, "keyStorePasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "sslKeyPassword": { "description": "Optional. Input only. The password for the cert inside of the KeyStore in plain text.", "type": "string" }, "sslKeyPasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password for the cert inside of the KeyStore. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of JavaMessageServiceConnection.", "type": "string" }, "useJndi": { "description": "Optional. If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.", "type": "boolean" }, "jndiConnectionFactory": { "description": "Optional. The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'", "type": "string" }, "jndiProviderUrl": { "description": "Optional. The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'", "type": "string" }, "jndiInitialContextFactory": { "description": "Optional. The implementation of javax.naming.spi.InitialContextFactory interface used to obtain initial naming context.", "type": "string" }, "jndiSecurityPrincipal": { "description": "Optional. Specifies the identity of the principal (user) to be authenticated.", "type": "string" }, "jndiSecurityCredentialsSecret": { "description": "Optional. The password associated to the principal.", "type": "string" }, "connectionUrl": { "description": "Optional. Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'", "type": "string" }, "connectionFactory": { "description": "Optional. The Java class implementing javax.jms.ConnectionFactory interface supplied by the JMS provider.", "type": "string" }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect to the Java Message Service.", "type": "string" }, "securityProtocol": { "description": "Optional. Security protocol for Java Message Service.", "type": "string", "enumDescriptions": [ "Security protocol not specified.", "Plain text communication.", "Transport Layer Security.", "Mutual Transport Layer Security." ], "enum": [ "JMS_SECURITY_PROTOCOL_UNSPECIFIED", "PLAIN", "TLS", "MTLS" ] }, "authenticationType": { "description": "Optional. Authentication type for Java Message Service.", "type": "string", "enumDescriptions": [ "Authentication type not specified.", "No authentication.", "Basic authentication." ], "enum": [ "JMS_AUTHENTICATION_TYPE_UNSPECIFIED", "NONE", "BASIC" ] }, "trustStoreFile": { "description": "Optional. The base64 encoded content of the TrustStore file.", "type": "string" }, "keyStoreFile": { "description": "Optional. The base64 encoded content of the KeyStore file.", "type": "string" } } }, "GoldengateMongodbConnectionProperties": { "id": "GoldengateMongodbConnectionProperties", "description": "The properties of GoldengateMongodbConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses to connect the Mongodb connection in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect the Mongodb connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "tlsCertificateKeyFilePassword": { "description": "Optional. Input only. The Client Certificate key file password in plain text.", "type": "string" }, "tlsCertificateKeyFilePasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the Client Certificate key file password in Secret Manager. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of MongodbConnection.", "type": "string" }, "connectionString": { "description": "Optional. MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'", "type": "string" }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect to the database.", "type": "string" }, "databaseId": { "description": "Optional. The OCID of the Oracle Autonomous Json Database.", "type": "string" }, "securityProtocol": { "description": "Optional. Security Type for MongoDB.", "type": "string", "enumDescriptions": [ "Security type not specified.", "Plain text communication.", "Transport Layer Security.", "Mutual Transport Layer Security." ], "enum": [ "MONGODB_SECURITY_PROTOCOL_UNSPECIFIED", "PLAIN", "TLS", "MTLS" ] }, "tlsCaFile": { "description": "Optional. Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).", "type": "string" }, "tlsCertificateKeyFile": { "description": "Optional. Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL).", "type": "string" } } }, "GoldengateOracleNosqlConnectionProperties": { "id": "GoldengateOracleNosqlConnectionProperties", "description": "The properties of GoldengateOracleNosqlConnection.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type of OracleNosqlConnection.", "type": "string" }, "tenancyId": { "description": "Optional. The OCID of the OCI tenancy.", "type": "string" }, "region": { "description": "Optional. The name of the region. e.g.: us-ashburn-1", "type": "string" }, "userId": { "description": "Optional. The OCID of the OCI user who will access the Oracle NoSQL database.", "type": "string" }, "privateKeyFile": { "description": "Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint.", "type": "string" }, "privateKeyPassphraseSecret": { "description": "Optional. The passphrase of the private key.", "type": "string" }, "publicKeyFingerprint": { "description": "Optional. The fingerprint of the API Key of the user specified by the userId.", "type": "string" }, "useResourcePrincipal": { "description": "Optional. Specifies that the user intends to authenticate to the instance using a resource principal.", "type": "boolean" } } }, "GoldengateSnowflakeConnectionProperties": { "id": "GoldengateSnowflakeConnectionProperties", "description": "The properties of GoldengateSnowflakeConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses to connect to Snowflake platform in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to Snowflake platform. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of SnowflakeConnection.", "type": "string" }, "connectionUrl": { "description": "Optional. JDBC connection URL. e.g.: 'jdbc:snowflake://.snowflakecomputing.com/?warehouse=&db='", "type": "string" }, "authenticationType": { "description": "Optional. Used authentication mechanism to access Snowflake.", "type": "string", "enumDescriptions": [ "Authentication type not specified.", "Basic authentication.", "Key pair authentication." ], "enum": [ "AUTHENTICATION_TYPE_UNSPECIFIED", "BASIC", "KEY_PAIR" ] }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect to Snowflake.", "type": "string" }, "privateKeyFile": { "description": "Optional. The content of private key file in PEM format.", "type": "string" }, "privateKeyPassphraseSecret": { "description": "Optional. Password if the private key file is encrypted.", "type": "string" } } }, "GoldengateAmazonRedshiftConnectionProperties": { "id": "GoldengateAmazonRedshiftConnectionProperties", "description": "The properties of GoldengateAmazonRedshiftConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses for Amazon Redshift connection in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Amazon Redshift connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of AmazonRedshiftConnection.", "type": "string" }, "connectionUrl": { "description": "Optional. Connection URL. e.g.: 'jdbc:redshift://aws-redshift-instance.aaaaaaaaaaaa.us-east-2.redshift.amazonaws.com:5439/mydb'", "type": "string" }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", "type": "string" } } }, "GoldengateElasticsearchConnectionProperties": { "id": "GoldengateElasticsearchConnectionProperties", "description": "The properties of GoldengateElasticsearchConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses for Elastic Search connection in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Elastic Search connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of ElasticsearchConnection.", "type": "string" }, "servers": { "description": "Optional. Comma separated list of Elasticsearch server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 9200. Example: \"server1.example.com:4000,server2.example.com:4000\"", "type": "string" }, "securityProtocol": { "description": "Optional. Security protocol for Elasticsearch.", "type": "string", "enumDescriptions": [ "Security protocol not specified.", "Plain text communication.", "Transport Layer Security." ], "enum": [ "ELASTICSEARCH_SECURITY_PROTOCOL_UNSPECIFIED", "PLAIN", "TLS" ] }, "authenticationType": { "description": "Optional. Authentication type for Elasticsearch.", "type": "string", "enumDescriptions": [ "Authentication type not specified.", "No authentication.", "Basic authentication." ], "enum": [ "ELASTICSEARCH_AUTHENTICATION_TYPE_UNSPECIFIED", "NONE", "BASIC" ] }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", "type": "string" }, "fingerprint": { "description": "Optional. Fingerprint required by TLS security protocol. Eg.: '6152b2dfbff200f973c5074a5b91d06ab3b472c07c09a1ea57bb7fd406cdce9c'", "type": "string" } } }, "GoldengateAmazonKinesisConnectionProperties": { "id": "GoldengateAmazonKinesisConnectionProperties", "description": "The properties of GoldengateAmazonKinesisConnection.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type of AmazonKinesisConnection.", "type": "string" }, "accessKeyId": { "description": "Optional. Access key ID to access the Amazon Kinesis.", "type": "string" }, "secretAccessKeySecret": { "description": "Optional. Secret access key to access the Amazon Kinesis.", "type": "string" }, "endpoint": { "description": "Optional. The endpoint URL of the Amazon Kinesis service. e.g.: 'https://kinesis.us-east-1.amazonaws.com' If not provided, Goldengate will default to 'https://kinesis..amazonaws.com'.", "type": "string" }, "awsRegion": { "description": "Optional. The name of the AWS region. If not provided, Goldengate will default to 'us-west-1'.", "type": "string" } } }, "GoldengateDb2ConnectionProperties": { "id": "GoldengateDb2ConnectionProperties", "description": "The properties of GoldengateDb2Connection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses for Db2 connection in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Db2 connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of Db2Connection.", "type": "string" }, "host": { "description": "Optional. The name or address of a host.", "type": "string" }, "port": { "description": "Optional. The port of an endpoint usually specified for a connection.", "type": "integer", "format": "int32" }, "database": { "description": "Optional. The name of the database.", "type": "string" }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect to the DB2 database.", "type": "string" }, "securityProtocol": { "description": "Optional. Security protocol for the DB2 database.", "type": "string", "enumDescriptions": [ "Security protocol not specified.", "Plain text communication.", "Transport Layer Security." ], "enum": [ "DB2_SECURITY_PROTOCOL_UNSPECIFIED", "PLAIN", "TLS" ] }, "additionalAttributes": { "description": "Optional. An array of name-value pair attribute entries. Used as additional parameters in connection string.", "type": "array", "items": { "$ref": "NameValuePair" } }, "sslClientKeystoredbFile": { "description": "Optional. The keystore file created at the client containing the server certificate / CA root certificate. Not supported for IBM Db2 for i.", "type": "string" }, "sslClientKeystashFile": { "description": "Optional. The keystash file which contains the encrypted password to the key database file. Not supported for IBM Db2 for i.", "type": "string" }, "sslServerCertificateFile": { "description": "Optional. The file which contains the self-signed server certificate / Certificate Authority (CA) certificate.", "type": "string" } } }, "GoldengateRedisConnectionProperties": { "id": "GoldengateRedisConnectionProperties", "description": "The properties of GoldengateRedisConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password Oracle Goldengate uses for Redis connection in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses for Redis connection. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "trustStorePassword": { "description": "Optional. Input only. The TrustStore password in plain text.", "type": "string" }, "trustStorePasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the TrustStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "keyStorePassword": { "description": "Optional. Input only. The KeyStore password in plain text.", "type": "string" }, "keyStorePasswordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the KeyStore password. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of RedisConnection.", "type": "string" }, "servers": { "description": "Optional. Comma separated list of Redis server addresses, specified as host:port entries, where :port is optional. If port is not specified, it defaults to 6379. Example: \"server1.example.com:6379,server2.example.com:6379\"", "type": "string" }, "securityProtocol": { "description": "Optional. Security protocol for Redis.", "type": "string", "enumDescriptions": [ "Security protocol not specified.", "Plain text communication.", "Transport Layer Security.", "Mutual Transport Layer Security." ], "enum": [ "REDIS_SECURITY_PROTOCOL_UNSPECIFIED", "PLAIN", "TLS", "MTLS" ] }, "authenticationType": { "description": "Optional. Authentication type for Redis.", "type": "string", "enumDescriptions": [ "Authentication type not specified.", "No authentication.", "Basic authentication." ], "enum": [ "REDIS_AUTHENTICATION_TYPE_UNSPECIFIED", "NONE", "BASIC" ] }, "username": { "description": "Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.", "type": "string" }, "redisClusterId": { "description": "Optional. The OCID of the Redis cluster.", "type": "string" }, "trustStoreFile": { "description": "Optional. The base64 encoded content of the TrustStore file.", "type": "string" }, "keyStoreFile": { "description": "Optional. The base64 encoded content of the KeyStore file.", "type": "string" } } }, "GoldengateDatabricksConnectionProperties": { "id": "GoldengateDatabricksConnectionProperties", "description": "The properties of GoldengateDatabricksConnection.", "type": "object", "properties": { "password": { "description": "Optional. Input only. The password used to connect to Databricks in plain text.", "type": "string" }, "passwordSecretVersion": { "description": "Optional. Input only. The resource name of a secret version in Secret Manager which contains the password used to connect to Databricks. Format: projects/{project}/secrets/{secret}/versions/{version}.", "type": "string" }, "technologyType": { "description": "Optional. The technology type of DatabricksConnection.", "type": "string" }, "authenticationType": { "description": "Optional. Authentication type for Databricks.", "type": "string", "enumDescriptions": [ "Authentication type not specified.", "Personal access token authentication.", "OAuth M2M authentication." ], "enum": [ "DATABRICKS_AUTHENTICATION_TYPE_UNSPECIFIED", "PERSONAL_ACCESS_TOKEN", "OAUTH_M2M" ] }, "connectionUrl": { "description": "Optional. Connection URL. e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'", "type": "string" }, "clientId": { "description": "Optional. OAuth client id, only applicable for authentication_type == OAUTH_M2M", "type": "string" }, "clientSecret": { "description": "Optional. OAuth client secret, only applicable for authentication_type == OAUTH_M2M", "type": "string" }, "storageCredential": { "description": "Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or Cloud Storage.", "type": "string" } } }, "GoldengateGooglePubsubConnectionProperties": { "id": "GoldengateGooglePubsubConnectionProperties", "description": "The properties of GoldengateGooglePubsubConnection.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type of GooglePubsubConnection.", "type": "string" }, "serviceAccountKeyFile": { "description": "Optional. The base64 encoded content of the service account key file containing the credentials required to use Google Pub/Sub.", "type": "string" } } }, "GoldengateMicrosoftFabricConnectionProperties": { "id": "GoldengateMicrosoftFabricConnectionProperties", "description": "The properties of GoldengateMicrosoftFabricConnection.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type of MicrosoftFabricConnection.", "type": "string" }, "tenantId": { "description": "Optional. Azure tenant ID of the application.", "type": "string" }, "clientId": { "description": "Optional. Azure client ID of the application.", "type": "string" }, "clientSecret": { "description": "Optional. Client secret associated with the client id.", "type": "string" }, "endpoint": { "description": "Optional. Optional Microsoft Fabric service endpoint. Default value: https://onelake.dfs.fabric.microsoft.com", "type": "string" } } }, "GoldengateOracleAIDataPlatformConnectionProperties": { "id": "GoldengateOracleAIDataPlatformConnectionProperties", "description": "The properties of GoldengateOracleAIDataPlatformConnection.", "type": "object", "properties": { "technologyType": { "description": "Optional. The technology type of OracleAiDataPlatformConnection.", "type": "string" }, "connectionUrl": { "description": "Optional. Connection URL. It must start with 'jdbc:spark://'", "type": "string" }, "tenancyId": { "description": "Optional. The OCID of the related OCI tenancy.", "type": "string" }, "region": { "description": "Optional. The name of the region. e.g.: us-ashburn-1", "type": "string" }, "userId": { "description": "Optional. The OCID of the OCI user who will access.", "type": "string" }, "privateKeyFile": { "description": "Optional. The content of the private key file (PEM file) corresponding to the API key of the fingerprint.", "type": "string" }, "privateKeyPassphraseSecret": { "description": "Optional. The passphrase of the private key.", "type": "string" }, "publicKeyFingerprint": { "description": "Optional. The fingerprint of the API Key of the user specified by the user_id.", "type": "string" }, "useResourcePrincipal": { "description": "Optional. Specifies that the user intends to authenticate to the instance using a resource principal.", "type": "boolean" } } }, "GoldengateIcebergConnectionProperties": { "id": "GoldengateIcebergConnectionProperties", "description": "The properties of GoldengateIcebergConnection.", "type": "object", "properties": { "technologyType": { "description": "Required. The technology type of Iceberg connection.", "type": "string" }, "catalog": { "description": "Required. The Iceberg catalog.", "$ref": "IcebergCatalog" }, "storage": { "description": "Required. The Iceberg storage.", "$ref": "IcebergStorage" } } }, "IcebergCatalog": { "id": "IcebergCatalog", "description": "The Iceberg catalog details.", "type": "object", "properties": { "glueIcebergCatalog": { "description": "The Glue Iceberg catalog.", "$ref": "GlueIcebergCatalog" }, "nessieIcebergCatalog": { "description": "The Nessie Iceberg catalog.", "$ref": "NessieIcebergCatalog" }, "polarisIcebergCatalog": { "description": "The Polaris Iceberg catalog.", "$ref": "PolarisIcebergCatalog" }, "restIcebergCatalog": { "description": "The REST Iceberg catalog.", "$ref": "RestIcebergCatalog" }, "catalogType": { "description": "Required. The type of Iceberg catalog.", "type": "string", "enumDescriptions": [ "Catalog type not specified.", "Glue catalog.", "Hadoop catalog.", "Nessie catalog.", "Polaris catalog.", "REST catalog." ], "enum": [ "CATALOG_TYPE_UNSPECIFIED", "GLUE", "HADOOP", "NESSIE", "POLARIS", "REST" ] } } }, "GlueIcebergCatalog": { "id": "GlueIcebergCatalog", "description": "The Glue Iceberg catalog.", "type": "object", "properties": { "glueId": { "description": "Required. The catalog ID of Glue.", "type": "string" } } }, "NessieIcebergCatalog": { "id": "NessieIcebergCatalog", "description": "The Nessie Iceberg catalog.", "type": "object", "properties": { "uri": { "description": "Required. The Nessie uri.", "type": "string" }, "branch": { "description": "Required. The Nessie branch.", "type": "string" } } }, "PolarisIcebergCatalog": { "id": "PolarisIcebergCatalog", "description": "The Polaris Iceberg catalog.", "type": "object", "properties": { "uri": { "description": "Required. The Polaris uri.", "type": "string" }, "polarisCatalog": { "description": "Required. The catalog name within Polaris.", "type": "string" }, "clientId": { "description": "Required. The Polaris client ID.", "type": "string" }, "principalRole": { "description": "Required. The Polaris principal role.", "type": "string" }, "clientSecret": { "description": "Optional. The Polaris client secret.", "type": "string" } } }, "RestIcebergCatalog": { "id": "RestIcebergCatalog", "description": "The REST Iceberg catalog.", "type": "object", "properties": { "uri": { "description": "Required. The REST uri.", "type": "string" }, "properties": { "description": "Optional. The base64 encoded content of the configuration file containing additional properties for the REST catalog.", "type": "string" } } }, "IcebergStorage": { "id": "IcebergStorage", "description": "The Iceberg storage details.", "type": "object", "properties": { "amazonS3IcebergStorage": { "description": "The Amazon S3 Iceberg storage.", "$ref": "AmazonS3IcebergStorage" }, "googleCloudStorageIcebergStorage": { "description": "The Google Cloud Storage Iceberg storage.", "$ref": "GoogleCloudStorageIcebergStorage" }, "azureDataLakeStorageIcebergStorage": { "description": "The Azure Data Lake Storage Iceberg storage.", "$ref": "AzureDataLakeStorageIcebergStorage" }, "storageType": { "description": "Required. The type of Iceberg storage.", "type": "string", "enumDescriptions": [ "Storage type not specified.", "Amazon S3 storage.", "Google Cloud Storage storage.", "Azure Data Lake Storage storage." ], "enum": [ "STORAGE_TYPE_UNSPECIFIED", "AMAZON_S3", "GOOGLE_CLOUD_STORAGE", "AZURE_DATA_LAKE_STORAGE" ] } } }, "AmazonS3IcebergStorage": { "id": "AmazonS3IcebergStorage", "description": "The Amazon S3 Iceberg storage.", "type": "object", "properties": { "schemeType": { "description": "Required. The scheme type of Amazon S3.", "type": "string", "enumDescriptions": [ "Scheme type not specified.", "S3 scheme.", "S3A scheme." ], "enum": [ "SCHEME_TYPE_UNSPECIFIED", "S3", "S3A" ] }, "accessKeyId": { "description": "Required. The access key ID of Amazon S3.", "type": "string" }, "region": { "description": "Required. The region of Amazon S3.", "type": "string" }, "bucket": { "description": "Required. The bucket of Amazon S3.", "type": "string" }, "endpoint": { "description": "Optional. The endpoint of Amazon S3.", "type": "string" }, "secretAccessKeySecret": { "description": "Optional. The secret access key of Amazon S3.", "type": "string" } } }, "GoogleCloudStorageIcebergStorage": { "id": "GoogleCloudStorageIcebergStorage", "description": "The Google Cloud Storage Iceberg storage.", "type": "object", "properties": { "bucket": { "description": "Required. The bucket of Google Cloud Storage.", "type": "string" }, "projectId": { "description": "Required. The project ID of Google Cloud Storage.", "type": "string" }, "serviceAccountKeyFile": { "description": "Optional. The base64 encoded content of the service account key file of Google Cloud Storage.", "type": "string" } } }, "AzureDataLakeStorageIcebergStorage": { "id": "AzureDataLakeStorageIcebergStorage", "description": "The Azure Data Lake Storage Iceberg storage.", "type": "object", "properties": { "azureAccount": { "description": "Required. The account of Azure Data Lake Storage.", "type": "string" }, "container": { "description": "Required. The container of Azure Data Lake Storage.", "type": "string" }, "accountKeySecret": { "description": "Optional. The account key of Azure Data Lake Storage.", "type": "string" }, "endpoint": { "description": "Optional. The endpoint of Azure Data Lake Storage.", "type": "string" } } }, "ListGoldengateDeploymentVersionsResponse": { "id": "ListGoldengateDeploymentVersionsResponse", "description": "Message for response to listing GoldengateDeploymentVersions", "type": "object", "properties": { "goldengateDeploymentVersions": { "description": "The list of GoldengateDeploymentVersion", "type": "array", "items": { "$ref": "GoldengateDeploymentVersion" } }, "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": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "GoldengateDeploymentVersion": { "id": "GoldengateDeploymentVersion", "description": "Details of the Goldengate Deployment Version resource.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Goldengate Deployment Version resource with the format: projects/{project}/locations/{location}/goldengateDeploymentVersions/{goldengate_deployment_version}", "type": "string" }, "ocid": { "description": "Output only. The deployment version ocid of the Goldengate Deployment Version resource.", "readOnly": true, "type": "string" }, "properties": { "description": "Output only. The technology type of the Goldengate Deployment Version resource.", "readOnly": true, "$ref": "GoldengateDeploymentVersionProperties" } } }, "GoldengateDeploymentVersionProperties": { "id": "GoldengateDeploymentVersionProperties", "description": "Properties of GoldengateDeploymentVersion.", "type": "object", "properties": { "deploymentType": { "description": "Output only. The deployment type of the Goldengate Deployment Version resource.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Goldengate Deployment Type category is OGG.", "Goldengate Deployment Type category is DATABASE_ORACLE.", "Goldengate Deployment Type category is BIGDATA.", "Goldengate Deployment Type category is DATABASE_MICROSOFT_SQLSERVER.", "Goldengate Deployment Type category is DATABASE_MYSQL.", "Goldengate Deployment Type category is DATABASE_POSTGRESQL.", "Goldengate Deployment Type category is DATABASE_DB2ZOS.", "Goldengate Deployment Type category is DATABASE_DB2I.", "Goldengate Deployment Type category is GGSA.", "Goldengate Deployment Type category is DATA_TRANSFORMS." ], "enum": [ "DEPLOYMENT_TYPE_UNSPECIFIED", "OGG", "DATABASE_ORACLE", "BIGDATA", "DATABASE_MICROSOFT_SQLSERVER", "DATABASE_MYSQL", "DATABASE_POSTGRESQL", "DATABASE_DB2ZOS", "DATABASE_DB2I", "GGSA", "DATA_TRANSFORMS" ] }, "securityFix": { "description": "Optional. Whether the Goldengate Deployment Version resource is a security fix.", "type": "boolean" }, "oggVersion": { "description": "Output only. The OGG version of the Goldengate Deployment Version resource.", "readOnly": true, "type": "string" }, "releaseType": { "description": "Output only. The release type of the Goldengate Deployment Version resource.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Goldengate Deployment Version release type is MAJOR.", "Goldengate Deployment Version release type is BUNDLE.", "Goldengate Deployment Version release type is MINOR." ], "enum": [ "DEPLOYMENT_RELEASE_TYPE_UNSPECIFIED", "MAJOR", "BUNDLE", "MINOR" ] }, "releaseTime": { "description": "Output only. The release time of the Goldengate Deployment Version resource.", "readOnly": true, "type": "string", "format": "google-datetime" }, "supportEndTime": { "description": "Output only. The support end time of the Goldengate Deployment Version resource.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "ListGoldengateDeploymentTypesResponse": { "id": "ListGoldengateDeploymentTypesResponse", "description": "Message for response to listing GoldengateDeploymentTypes", "type": "object", "properties": { "goldengateDeploymentTypes": { "description": "The list of GoldengateDeploymentType", "type": "array", "items": { "$ref": "GoldengateDeploymentType" } }, "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": { "description": "Unordered list. The resource names of locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "GoldengateDeploymentType": { "id": "GoldengateDeploymentType", "description": "Details of the Goldengate Deployment Type resource.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Goldengate Deployment Type resource with the format: projects/{project}/locations/{region}/goldengateDeploymentTypes/{goldengate_deployment_type}", "type": "string" }, "deploymentType": { "description": "Output only. The deployment type of the Goldengate Deployment Type resource.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Goldengate Deployment Type category is OGG.", "Goldengate Deployment Type category is DATABASE_ORACLE.", "Goldengate Deployment Type category is BIGDATA.", "Goldengate Deployment Type category is DATABASE_MICROSOFT_SQLSERVER.", "Goldengate Deployment Type category is DATABASE_MYSQL.", "Goldengate Deployment Type category is DATABASE_POSTGRESQL.", "Goldengate Deployment Type category is DATABASE_DB2ZOS.", "Goldengate Deployment Type category is DATABASE_DB2I.", "Goldengate Deployment Type category is GGSA.", "Goldengate Deployment Type category is DATA_TRANSFORMS." ], "enum": [ "DEPLOYMENT_TYPE_UNSPECIFIED", "OGG", "DATABASE_ORACLE", "BIGDATA", "DATABASE_MICROSOFT_SQLSERVER", "DATABASE_MYSQL", "DATABASE_POSTGRESQL", "DATABASE_DB2ZOS", "DATABASE_DB2I", "GGSA", "DATA_TRANSFORMS" ] }, "category": { "description": "Output only. The category of the Goldengate Deployment Type resource.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Goldengate Deployment Type category is DATA_REPLICATION_CATEGORY.", "Goldengate Deployment Type category is DATA_TRANSFORMS_CATEGORY." ], "enum": [ "DEPLOYMENT_CATEGORY_UNSPECIFIED", "DATA_REPLICATION_CATEGORY", "DATA_TRANSFORMS_CATEGORY" ] }, "connectionTypes": { "description": "Output only. The connection types of the Goldengate Deployment Type resource.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "displayName": { "description": "Output only. The display name of the Goldengate Deployment Type resource.", "readOnly": true, "type": "string" }, "oggVersion": { "description": "Output only. The Ogg version of the Goldengate Deployment Type resource.", "readOnly": true, "type": "string" }, "sourceTechnologies": { "description": "Output only. The source technologies of the Goldengate Deployment Type resource.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "supportedCapabilities": { "description": "Output only. The supported capabilities of the Goldengate Deployment Type resource.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "supportedTechnologiesUrl": { "description": "Output only. The supported technologies URL of the Goldengate Deployment Type resource.", "readOnly": true, "type": "string" }, "targetTechnologies": { "description": "Output only. The target technologies of the Goldengate Deployment Type resource.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "defaultUsername": { "description": "Output only. The default username of the Goldengate Deployment Type resource.", "readOnly": true, "type": "string" } } }, "ListGoldengateDeploymentEnvironmentsResponse": { "id": "ListGoldengateDeploymentEnvironmentsResponse", "description": "Message for response to listing GoldengateDeploymentEnvironments", "type": "object", "properties": { "goldengateDeploymentEnvironments": { "description": "The list of GoldengateDeploymentEnvironment", "type": "array", "items": { "$ref": "GoldengateDeploymentEnvironment" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return. If this field is empty, there are no subsequent pages.", "type": "string" }, "unreachable": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "GoldengateDeploymentEnvironment": { "id": "GoldengateDeploymentEnvironment", "description": "Details of the Goldengate Deployment Environment resource.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Goldengate Deployment Environment resource with the format: projects/{project}/locations/{location}/goldengateDeploymentEnvironments/{goldengate_deployment_environment}", "type": "string" }, "category": { "description": "Output only. The category of the Goldengate Deployment Environment resource.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Goldengate Deployment Environment category is DATA_REPLICATION_CATEGORY.", "Goldengate Deployment Environment category is DATA_TRANSFORMS_CATEGORY." ], "enum": [ "DEPLOYMENT_CATEGORY_UNSPECIFIED", "DATA_REPLICATION_CATEGORY", "DATA_TRANSFORMS_CATEGORY" ] }, "displayName": { "description": "The display name of the Goldengate Deployment Environment resource.", "type": "string" }, "defaultCpuCoreCount": { "description": "Output only. The default CPU core count of the Goldengate Deployment Environment resource.", "readOnly": true, "type": "integer", "format": "int32" }, "environmentType": { "description": "Output only. The environment type of the Goldengate Deployment Environment resource.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Goldengate Deployment Environment type is PRODUCTION.", "Goldengate Deployment Environment type is DEVELOPMENT_OR_TESTING." ], "enum": [ "DEPLOYMENT_ENVIRONMENT_TYPE_UNSPECIFIED", "PRODUCTION", "DEVELOPMENT_OR_TESTING" ] }, "autoScalingEnabled": { "description": "Output only. Whether auto scaling is enabled by default for the Goldengate Deployment Environment resource.", "readOnly": true, "type": "boolean" }, "maxCpuCoreCount": { "description": "Output only. The max CPU core count of the Goldengate Deployment Environment resource.", "readOnly": true, "type": "integer", "format": "int32" }, "memoryGbPerCpuCore": { "description": "Output only. The memory per CPU core in GBs of the Goldengate Deployment Environment resource.", "readOnly": true, "type": "integer", "format": "int32" }, "minCpuCoreCount": { "description": "Output only. The min CPU core count of the Goldengate Deployment Environment resource.", "readOnly": true, "type": "integer", "format": "int32" }, "networkBandwidthGbpsPerCpuCore": { "description": "Output only. The network bandwidth per CPU core in Gbps of the Goldengate Deployment Environment resource.", "readOnly": true, "type": "integer", "format": "int32" }, "storageUsageLimitGbPerCpuCore": { "description": "Output only. The storage usage limit per CPU core in GBs of the Goldengate Deployment Environment resource.", "readOnly": true, "type": "integer", "format": "int32" } } }, "ListGoldengateConnectionTypesResponse": { "id": "ListGoldengateConnectionTypesResponse", "description": "Message for response to listing GoldengateConnectionTypes", "type": "object", "properties": { "goldengateConnectionTypes": { "description": "The list of GoldengateConnectionType", "type": "array", "items": { "$ref": "GoldengateConnectionType" } }, "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": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "GoldengateConnectionType": { "id": "GoldengateConnectionType", "description": "Details of the Goldengate Connection Type resource.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Goldengate Connection Type resource with the format: projects/{project}/locations/{region}/goldengateConnectionTypes/{goldengate_connection_type}", "type": "string" }, "connectionType": { "description": "Output only. The connection type of the Goldengate Connection Type resource.", "readOnly": true, "type": "string", "enumDescriptions": [ "Default unspecified value.", "Goldengate Connection Type category is GOLDENGATE.", "Goldengate Connection Type category is KAFKA.", "Goldengate Connection Type category is KAFKA_SCHEMA_REGISTRY.", "Goldengate Connection Type category is MYSQL.", "Goldengate Connection Type category is JAVA_MESSAGE_SERVICE.", "Goldengate Connection Type category is MICROSOFT_SQLSERVER.", "Goldengate Connection Type category is OCI_OBJECT_STORAGE.", "Goldengate Connection Type category is ORACLE.", "Goldengate Connection Type category is AZURE_DATA_LAKE_STORAGE.", "Goldengate Connection Type category is POSTGRESQL.", "Goldengate Connection Type category is AZURE_SYNAPSE_ANALYTICS.", "Goldengate Connection Type category is SNOWFLAKE.", "Goldengate Connection Type category is AMAZON_S3.", "Goldengate Connection Type category is HDFS.", "Goldengate Connection Type category is ORACLE_AI_DATA_PLATFORM.", "Goldengate Connection Type category is ORACLE_NOSQL.", "Goldengate Connection Type category is MONGODB.", "Goldengate Connection Type category is AMAZON_KINESIS.", "Goldengate Connection Type category is AMAZON_REDSHIFT.", "Goldengate Connection Type category is DB2.", "Goldengate Connection Type category is REDIS.", "Goldengate Connection Type category is ELASTICSEARCH.", "Goldengate Connection Type category is GENERIC.", "Goldengate Connection Type category is GOOGLE_CLOUD_STORAGE.", "Goldengate Connection Type category is GOOGLE_BIGQUERY.", "Goldengate Connection Type category is DATABRICKS.", "Goldengate Connection Type category is GOOGLE_PUBSUB.", "Goldengate Connection Type category is MICROSOFT_FABRIC.", "Goldengate Connection Type category is ICEBERG." ], "enum": [ "CONNECTION_TYPE_UNSPECIFIED", "GOLDENGATE", "KAFKA", "KAFKA_SCHEMA_REGISTRY", "MYSQL", "JAVA_MESSAGE_SERVICE", "MICROSOFT_SQLSERVER", "OCI_OBJECT_STORAGE", "ORACLE", "AZURE_DATA_LAKE_STORAGE", "POSTGRESQL", "AZURE_SYNAPSE_ANALYTICS", "SNOWFLAKE", "AMAZON_S3", "HDFS", "ORACLE_AI_DATA_PLATFORM", "ORACLE_NOSQL", "MONGODB", "AMAZON_KINESIS", "AMAZON_REDSHIFT", "DB2", "REDIS", "ELASTICSEARCH", "GENERIC", "GOOGLE_CLOUD_STORAGE", "GOOGLE_BIGQUERY", "DATABRICKS", "GOOGLE_PUBSUB", "MICROSOFT_FABRIC", "ICEBERG" ] }, "technologyTypes": { "description": "Output only. The technology type of the Goldengate Connection Type resource.", "readOnly": true, "type": "array", "items": { "type": "string" } } } }, "ListDbVersionsResponse": { "id": "ListDbVersionsResponse", "description": "The response for `DbVersions.List`.", "type": "object", "properties": { "dbVersions": { "description": "The list of DbVersions.", "type": "array", "items": { "$ref": "DbVersion" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "DbVersion": { "id": "DbVersion", "description": "A valid Oracle Database version.", "type": "object", "properties": { "name": { "description": "Output only. The name of the DbVersion resource in the following format: projects/{project}/locations/{region}/dbVersions/{db_version}", "readOnly": true, "type": "string" }, "properties": { "description": "Output only. The properties of the DbVersion.", "readOnly": true, "$ref": "DbVersionProperties" } } }, "DbVersionProperties": { "id": "DbVersionProperties", "description": "The properties of a DbVersion.", "type": "object", "properties": { "version": { "description": "Output only. A valid Oracle Database version.", "readOnly": true, "type": "string" }, "isLatestForMajorVersion": { "description": "Output only. True if this version of the Oracle Database software is the latest version for a release.", "readOnly": true, "type": "boolean" }, "supportsPdb": { "description": "Output only. True if this version of the Oracle Database software supports pluggable databases.", "readOnly": true, "type": "boolean" }, "isPreviewDbVersion": { "description": "Output only. True if this version of the Oracle Database software is the preview version.", "readOnly": true, "type": "boolean" }, "isUpgradeSupported": { "description": "Output only. True if this version of the Oracle Database software is supported for Upgrade.", "readOnly": true, "type": "boolean" } } }, "ListDatabaseCharacterSetsResponse": { "id": "ListDatabaseCharacterSetsResponse", "description": "The response for `DatabaseCharacterSet.List`.", "type": "object", "properties": { "databaseCharacterSets": { "description": "The list of DatabaseCharacterSets.", "type": "array", "items": { "$ref": "DatabaseCharacterSet" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "DatabaseCharacterSet": { "id": "DatabaseCharacterSet", "description": "Details of the Database character set resource.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the Database Character Set resource in the following format: projects/{project}/locations/{region}/databaseCharacterSets/{database_character_set}", "type": "string" }, "characterSetType": { "description": "Output only. The character set type for the Database.", "readOnly": true, "type": "string", "enumDescriptions": [ "Character set type is not specified.", "Character set type is set to database.", "Character set type is set to national." ], "enum": [ "CHARACTER_SET_TYPE_UNSPECIFIED", "DATABASE", "NATIONAL" ] }, "characterSet": { "description": "Output only. The character set name for the Database which is the ID in the resource name.", "readOnly": true, "type": "string" } } }, "ListGoldengateConnectionAssignmentsResponse": { "id": "ListGoldengateConnectionAssignmentsResponse", "description": "Response message for listing GoldengateConnectionAssignments.", "type": "object", "properties": { "goldengateConnectionAssignments": { "description": "The list of GoldengateConnectionAssignments.", "type": "array", "items": { "$ref": "GoldengateConnectionAssignment" } }, "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": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "type": "array", "items": { "type": "string" } } } }, "GoldengateConnectionAssignment": { "id": "GoldengateConnectionAssignment", "description": "Represents the metadata of a Goldengate Connection Assignment.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the GoldengateConnectionAssignment resource in the following format: projects/{project}/locations/{region}/goldengateConnectionAssignments/{goldengate_connection_assignment}", "type": "string" }, "properties": { "description": "Required. The properties of the GoldengateConnectionAssignment.", "$ref": "GoldengateConnectionAssignmentProperties" }, "createTime": { "description": "Output only. The time when the connection assignment was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "labels": { "description": "Optional. The labels or tags associated with the GoldengateConnectionAssignment.", "type": "object", "additionalProperties": { "type": "string" } }, "displayName": { "description": "Optional. The display name for the GoldengateConnectionAssignment.", "type": "string" }, "entitlementId": { "description": "Output only. The OCID of the entitlement linked to this resource.", "readOnly": true, "type": "string" } } }, "GoldengateConnectionAssignmentProperties": { "id": "GoldengateConnectionAssignmentProperties", "description": "The properties of a GoldengateConnectionAssignment.", "type": "object", "properties": { "ocid": { "description": "Output only. The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the connection assignment being referenced.", "readOnly": true, "type": "string" }, "goldengateConnection": { "description": "Required. The GoldengateConnection resource to be assigned. Format: projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}", "type": "string" }, "goldengateDeployment": { "description": "Required. The GoldenGateDeployment to assign the connection to. Format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}", "type": "string" }, "alias": { "description": "Output only. Credential store alias.", "readOnly": true, "type": "string" }, "state": { "description": "Output only. The lifecycle state of the connection assignment.", "readOnly": true, "type": "string", "enumDescriptions": [ "Lifecycle state is unspecified.", "Connection assignment is being created.", "Connection assignment is active.", "Connection assignment failed.", "Connection assignment is being updated.", "Connection assignment is being deleted." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "FAILED", "UPDATING", "DELETING" ] } } }, "TestGoldengateConnectionAssignmentRequest": { "id": "TestGoldengateConnectionAssignmentRequest", "description": "Request message for TestGoldengateConnectionAssignment.", "type": "object", "properties": { "type": { "description": "Optional. The type of the test of the assigned connection. The only type actually supported is DEFAULT.", "type": "string", "enumDescriptions": [ "The default value. This value is unused.", "The default connection test." ], "enum": [ "TEST_TYPE_UNSPECIFIED", "DEFAULT" ] } } }, "TestGoldengateConnectionAssignmentResponse": { "id": "TestGoldengateConnectionAssignmentResponse", "description": "The result of the connectivity test performed between the Goldengate deployment and the associated database / service.", "type": "object", "properties": { "resultType": { "description": "Type of the result i.e. Success, Failure or Timeout.", "type": "string", "enumDescriptions": [ "Result type is unspecified.", "Test connection succeeded.", "Test connection failed.", "Test connection timed out." ], "enum": [ "RESULT_TYPE_UNSPECIFIED", "SUCCEEDED", "FAILED", "TIMED_OUT" ] }, "error": { "description": "Error details if test connection failed.", "$ref": "TestConnectionAssignmentError" }, "errors": { "description": "List of test connection assignment error objects.", "type": "array", "items": { "$ref": "TestConnectionAssignmentError" } } } }, "TestConnectionAssignmentError": { "id": "TestConnectionAssignmentError", "description": "Error details for TestGoldengateConnectionAssignment.", "type": "object", "properties": { "code": { "description": "A short error code that defines the error, meant for programmatic parsing.", "type": "string" }, "message": { "description": "A human-readable error message.", "type": "string" }, "action": { "description": "The text describing the action required to fix the issue.", "type": "string" }, "issue": { "description": "The text describing the root cause of the reported issue.", "type": "string" } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "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\"}", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "OperationMetadata": { "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. The time the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "statusMessage": { "description": "Output only. The status of the operation.", "readOnly": true, "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" }, "percentComplete": { "description": "Output only. An estimated percentage of the operation that has been completed at a given moment of time, between 0 and 100.", "readOnly": true, "type": "number", "format": "double" } } }, "LocationMetadata": { "id": "LocationMetadata", "description": "Metadata for a given Location.", "type": "object", "properties": { "gcpOracleZones": { "description": "Output only. Google Cloud Platform Oracle zones in a location.", "readOnly": true, "type": "array", "items": { "type": "string" } } } } }, "ownerDomain": "google.com", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "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.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "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.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "title": "Oracle Database@Google Cloud API", "documentationLink": "https://cloud.google.com/oracle/database/docs", "version": "v1", "rootUrl": "https://oracledatabase.googleapis.com/", "servicePath": "", "mtlsRootUrl": "https://oracledatabase.mtls.googleapis.com/", "canonicalName": "Oracle Database", "revision": "20260615", "ownerName": "Google", "fullyEncodeReservedExpansion": true }