Close httplib2 connections.
create(parent, autonomousDatabaseId=None, body=None, requestId=None, x__xgafv=None)
Creates a new Autonomous Database in a given project and location.
delete(name, requestId=None, x__xgafv=None)
Deletes a single Autonomous Database.
generateWallet(name, body=None, x__xgafv=None)
Generates a wallet for an Autonomous Database.
Gets the details of a single Autonomous Database.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the Autonomous Databases in a given project and location.
Retrieves the next page of results.
restore(name, body=None, x__xgafv=None)
Restores a single Autonomous Database.
close()
Close httplib2 connections.
create(parent, autonomousDatabaseId=None, body=None, requestId=None, x__xgafv=None)
Creates a new Autonomous Database in a given project and location.
Args:
parent: string, Required. The name of the parent in the following format: projects/{project}/locations/{location}. (required)
body: object, The request body.
The object takes the form of:
{ # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/
"adminPassword": "A String", # Optional. The password for the default ADMIN user.
"cidr": "A String", # Required. The subnet CIDR range for the Autonmous Database.
"createTime": "A String", # Output only. The date and time that the Autonomous Database was created.
"database": "A String", # Optional. 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.
"displayName": "A String", # Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the Autonomous Database.
"labels": { # Optional. The labels or tags associated with the Autonomous Database.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
"network": "A String", # Required. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}
"properties": { # The properties of an Autonomous Database. # Optional. The properties of the Autonomous Database.
"actualUsedDataStorageSizeTb": 3.14, # Output only. The amount of storage currently being used for user and system data, in terabytes.
"allocatedStorageSizeTb": 3.14, # Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.
"apexDetails": { # Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex # Output only. The details for the Oracle APEX Application Development.
"apexVersion": "A String", # Output only. The Oracle APEX Application Development version.
"ordsVersion": "A String", # Output only. The Oracle REST Data Services (ORDS) version.
},
"arePrimaryAllowlistedIpsUsed": True or False, # 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.
"autonomousContainerDatabaseId": "A String", # Output only. The Autonomous Container Database OCID.
"availableUpgradeVersions": [ # Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.
"A String",
],
"backupRetentionPeriodDays": 42, # Optional. 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.
"characterSet": "A String", # Optional. The character set for the Autonomous Database. The default is AL32UTF8.
"computeCount": 3.14, # Optional. The number of compute servers for the Autonomous Database.
"connectionStrings": { # The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings # Output only. The connection strings used to connect to an Autonomous Database.
"allConnectionStrings": { # A list of all connection strings that can be used to connect to the Autonomous Database. # Output only. Returns all connection strings that can be used to connect to the Autonomous Database.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
},
"dedicated": "A String", # Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
"profiles": [ # Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.
{ # The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile
"consumerGroup": "A String", # Output only. The current consumer group being used by the connection.
"displayName": "A String", # Output only. The display name for the database connection.
"hostFormat": "A String", # Output only. The host name format being currently used in connection string.
"isRegional": True or False, # Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.
"protocol": "A String", # Output only. The protocol being used by the connection.
"sessionMode": "A String", # Output only. The current session mode of the connection.
"syntaxFormat": "A String", # Output only. The syntax of the connection string.
"tlsAuthentication": "A String", # Output only. This field indicates the TLS authentication type of the connection.
"value": "A String", # Output only. The value of the connection string.
},
],
},
"connectionUrls": { # 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 # Output only. The Oracle Connection URLs for an Autonomous Database.
"apexUri": "A String", # Output only. Oracle Application Express (APEX) URL.
"databaseTransformsUri": "A String", # Output only. The URL of the Database Transforms for the Autonomous Database.
"graphStudioUri": "A String", # Output only. The URL of the Graph Studio for the Autonomous Database.
"machineLearningNotebookUri": "A String", # Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.
"machineLearningUserManagementUri": "A String", # Output only. The URL of Machine Learning user management the Autonomous Database.
"mongoDbUri": "A String", # Output only. The URL of the MongoDB API for the Autonomous Database.
"ordsUri": "A String", # Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.
"sqlDevWebUri": "A String", # Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.
},
"cpuCoreCount": 42, # Optional. The number of CPU cores to be made available to the database.
"customerContacts": [ # Optional. The list of customer contacts.
{ # The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact
"email": "A String", # Required. The email address used by Oracle to send notifications regarding databases and infrastructure.
},
],
"dataSafeState": "A String", # Output only. The current state of the Data Safe registration for the Autonomous Database.
"dataStorageSizeGb": 42, # Optional. The size of the data stored in the database, in gigabytes.
"dataStorageSizeTb": 42, # Optional. The size of the data stored in the database, in terabytes.
"databaseManagementState": "A String", # Output only. The current state of database management for the Autonomous Database.
"dbEdition": "A String", # Optional. The edition of the Autonomous Databases.
"dbVersion": "A String", # Optional. The Oracle Database version for the Autonomous Database.
"dbWorkload": "A String", # Required. The workload type of the Autonomous Database.
"failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover.
"isAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.
"isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.
"isStorageAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.
"licenseType": "A String", # Required. The license type used for the Autonomous Database.
"lifecycleDetails": "A String", # Output only. The details of the current lifestyle state of the Autonomous Database.
"localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.
"localDisasterRecoveryType": "A String", # Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.
"localStandbyDb": { # Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary # Output only. The details of the Autonomous Data Guard standby database.
"dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.
"disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
"lagTimeDuration": "A String", # 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.
"lifecycleDetails": "A String", # Output only. The additional details about the current lifecycle state of the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
},
"maintenanceBeginTime": "A String", # Output only. The date and time when maintenance will begin.
"maintenanceEndTime": "A String", # Output only. The date and time when maintenance will end.
"maintenanceScheduleType": "A String", # Optional. The maintenance schedule of the Autonomous Database.
"memoryPerOracleComputeUnitGbs": 42, # Output only. The amount of memory enabled per ECPU, in gigabytes.
"memoryTableGbs": 42, # Output only. The memory assigned to in-memory tables in an Autonomous Database.
"mtlsConnectionRequired": True or False, # Optional. This field specifies if the Autonomous Database requires mTLS connections.
"nCharacterSet": "A String", # Optional. The national character set for the Autonomous Database. The default is AL16UTF16.
"nextLongTermBackupTime": "A String", # Output only. The long term backup schedule of the Autonomous Database.
"ociUrl": "A String", # Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.
"ocid": "A String", # Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
"openMode": "A String", # Output only. This field indicates the current mode of the Autonomous Database.
"operationsInsightsState": "A String", # Output only. This field indicates the state of Operations Insights for the Autonomous Database.
"peerDbIds": [ # Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.
"A String",
],
"permissionLevel": "A String", # Output only. The permission level of the Autonomous Database.
"privateEndpoint": "A String", # Output only. The private endpoint for the Autonomous Database.
"privateEndpointIp": "A String", # Optional. The private endpoint IP address for the Autonomous Database.
"privateEndpointLabel": "A String", # Optional. The private endpoint label for the Autonomous Database.
"refreshableMode": "A String", # Output only. The refresh mode of the cloned Autonomous Database.
"refreshableState": "A String", # Output only. The refresh State of the clone.
"role": "A String", # Output only. The Data Guard role of the Autonomous Database.
"scheduledOperationDetails": [ # Output only. The list and details of the scheduled operations of the Autonomous Database.
{ # Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails
"dayOfWeek": "A String", # Output only. Day of week.
"startTime": { # 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`. # Output only. Auto start time.
"hours": 42, # 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.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # 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.
},
"stopTime": { # 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`. # Output only. Auto stop time.
"hours": 42, # 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.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # 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.
},
},
],
"secretId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault secret.
"sqlWebDeveloperUrl": "A String", # Output only. The SQL Web Developer URL for the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
"supportedCloneRegions": [ # Output only. The list of available regions that can be used to create a clone for the Autonomous Database.
"A String",
],
"totalAutoBackupStorageSizeGbs": 3.14, # Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.
"usedDataStorageSizeTbs": 42, # Output only. The storage space used by Autonomous Database, in gigabytes.
"vaultId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault.
},
}
autonomousDatabaseId: string, 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.
requestId: string, 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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, requestId=None, x__xgafv=None)
Deletes a single Autonomous Database.
Args:
name: string, Required. The name of the resource in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
requestId: string, 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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
generateWallet(name, body=None, x__xgafv=None)
Generates a wallet for an Autonomous Database.
Args:
name: string, Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
body: object, The request body.
The object takes the form of:
{ # The request for `AutonomousDatabase.GenerateWallet`.
"isRegional": True or False, # Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only.
"password": "A String", # Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters.
"type": "A String", # Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for `AutonomousDatabase.GenerateWallet`.
"archiveContent": "A String", # Output only. The base64 encoded wallet files.
}
get(name, x__xgafv=None)
Gets the details of a single Autonomous Database.
Args:
name: string, Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/
"adminPassword": "A String", # Optional. The password for the default ADMIN user.
"cidr": "A String", # Required. The subnet CIDR range for the Autonmous Database.
"createTime": "A String", # Output only. The date and time that the Autonomous Database was created.
"database": "A String", # Optional. 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.
"displayName": "A String", # Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the Autonomous Database.
"labels": { # Optional. The labels or tags associated with the Autonomous Database.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
"network": "A String", # Required. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}
"properties": { # The properties of an Autonomous Database. # Optional. The properties of the Autonomous Database.
"actualUsedDataStorageSizeTb": 3.14, # Output only. The amount of storage currently being used for user and system data, in terabytes.
"allocatedStorageSizeTb": 3.14, # Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.
"apexDetails": { # Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex # Output only. The details for the Oracle APEX Application Development.
"apexVersion": "A String", # Output only. The Oracle APEX Application Development version.
"ordsVersion": "A String", # Output only. The Oracle REST Data Services (ORDS) version.
},
"arePrimaryAllowlistedIpsUsed": True or False, # 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.
"autonomousContainerDatabaseId": "A String", # Output only. The Autonomous Container Database OCID.
"availableUpgradeVersions": [ # Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.
"A String",
],
"backupRetentionPeriodDays": 42, # Optional. 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.
"characterSet": "A String", # Optional. The character set for the Autonomous Database. The default is AL32UTF8.
"computeCount": 3.14, # Optional. The number of compute servers for the Autonomous Database.
"connectionStrings": { # The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings # Output only. The connection strings used to connect to an Autonomous Database.
"allConnectionStrings": { # A list of all connection strings that can be used to connect to the Autonomous Database. # Output only. Returns all connection strings that can be used to connect to the Autonomous Database.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
},
"dedicated": "A String", # Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
"profiles": [ # Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.
{ # The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile
"consumerGroup": "A String", # Output only. The current consumer group being used by the connection.
"displayName": "A String", # Output only. The display name for the database connection.
"hostFormat": "A String", # Output only. The host name format being currently used in connection string.
"isRegional": True or False, # Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.
"protocol": "A String", # Output only. The protocol being used by the connection.
"sessionMode": "A String", # Output only. The current session mode of the connection.
"syntaxFormat": "A String", # Output only. The syntax of the connection string.
"tlsAuthentication": "A String", # Output only. This field indicates the TLS authentication type of the connection.
"value": "A String", # Output only. The value of the connection string.
},
],
},
"connectionUrls": { # 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 # Output only. The Oracle Connection URLs for an Autonomous Database.
"apexUri": "A String", # Output only. Oracle Application Express (APEX) URL.
"databaseTransformsUri": "A String", # Output only. The URL of the Database Transforms for the Autonomous Database.
"graphStudioUri": "A String", # Output only. The URL of the Graph Studio for the Autonomous Database.
"machineLearningNotebookUri": "A String", # Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.
"machineLearningUserManagementUri": "A String", # Output only. The URL of Machine Learning user management the Autonomous Database.
"mongoDbUri": "A String", # Output only. The URL of the MongoDB API for the Autonomous Database.
"ordsUri": "A String", # Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.
"sqlDevWebUri": "A String", # Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.
},
"cpuCoreCount": 42, # Optional. The number of CPU cores to be made available to the database.
"customerContacts": [ # Optional. The list of customer contacts.
{ # The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact
"email": "A String", # Required. The email address used by Oracle to send notifications regarding databases and infrastructure.
},
],
"dataSafeState": "A String", # Output only. The current state of the Data Safe registration for the Autonomous Database.
"dataStorageSizeGb": 42, # Optional. The size of the data stored in the database, in gigabytes.
"dataStorageSizeTb": 42, # Optional. The size of the data stored in the database, in terabytes.
"databaseManagementState": "A String", # Output only. The current state of database management for the Autonomous Database.
"dbEdition": "A String", # Optional. The edition of the Autonomous Databases.
"dbVersion": "A String", # Optional. The Oracle Database version for the Autonomous Database.
"dbWorkload": "A String", # Required. The workload type of the Autonomous Database.
"failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover.
"isAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.
"isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.
"isStorageAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.
"licenseType": "A String", # Required. The license type used for the Autonomous Database.
"lifecycleDetails": "A String", # Output only. The details of the current lifestyle state of the Autonomous Database.
"localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.
"localDisasterRecoveryType": "A String", # Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.
"localStandbyDb": { # Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary # Output only. The details of the Autonomous Data Guard standby database.
"dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.
"disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
"lagTimeDuration": "A String", # 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.
"lifecycleDetails": "A String", # Output only. The additional details about the current lifecycle state of the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
},
"maintenanceBeginTime": "A String", # Output only. The date and time when maintenance will begin.
"maintenanceEndTime": "A String", # Output only. The date and time when maintenance will end.
"maintenanceScheduleType": "A String", # Optional. The maintenance schedule of the Autonomous Database.
"memoryPerOracleComputeUnitGbs": 42, # Output only. The amount of memory enabled per ECPU, in gigabytes.
"memoryTableGbs": 42, # Output only. The memory assigned to in-memory tables in an Autonomous Database.
"mtlsConnectionRequired": True or False, # Optional. This field specifies if the Autonomous Database requires mTLS connections.
"nCharacterSet": "A String", # Optional. The national character set for the Autonomous Database. The default is AL16UTF16.
"nextLongTermBackupTime": "A String", # Output only. The long term backup schedule of the Autonomous Database.
"ociUrl": "A String", # Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.
"ocid": "A String", # Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
"openMode": "A String", # Output only. This field indicates the current mode of the Autonomous Database.
"operationsInsightsState": "A String", # Output only. This field indicates the state of Operations Insights for the Autonomous Database.
"peerDbIds": [ # Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.
"A String",
],
"permissionLevel": "A String", # Output only. The permission level of the Autonomous Database.
"privateEndpoint": "A String", # Output only. The private endpoint for the Autonomous Database.
"privateEndpointIp": "A String", # Optional. The private endpoint IP address for the Autonomous Database.
"privateEndpointLabel": "A String", # Optional. The private endpoint label for the Autonomous Database.
"refreshableMode": "A String", # Output only. The refresh mode of the cloned Autonomous Database.
"refreshableState": "A String", # Output only. The refresh State of the clone.
"role": "A String", # Output only. The Data Guard role of the Autonomous Database.
"scheduledOperationDetails": [ # Output only. The list and details of the scheduled operations of the Autonomous Database.
{ # Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails
"dayOfWeek": "A String", # Output only. Day of week.
"startTime": { # 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`. # Output only. Auto start time.
"hours": 42, # 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.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # 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.
},
"stopTime": { # 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`. # Output only. Auto stop time.
"hours": 42, # 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.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # 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.
},
},
],
"secretId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault secret.
"sqlWebDeveloperUrl": "A String", # Output only. The SQL Web Developer URL for the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
"supportedCloneRegions": [ # Output only. The list of available regions that can be used to create a clone for the Autonomous Database.
"A String",
],
"totalAutoBackupStorageSizeGbs": 3.14, # Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.
"usedDataStorageSizeTbs": 42, # Output only. The storage space used by Autonomous Database, in gigabytes.
"vaultId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault.
},
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the Autonomous Databases in a given project and location.
Args:
parent: string, Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}. (required)
filter: string, Optional. An expression for filtering the results of the request.
orderBy: string, Optional. An expression for ordering the results of the request.
pageSize: integer, 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.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for `AutonomousDatabase.List`.
"autonomousDatabases": [ # The list of Autonomous Databases.
{ # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/
"adminPassword": "A String", # Optional. The password for the default ADMIN user.
"cidr": "A String", # Required. The subnet CIDR range for the Autonmous Database.
"createTime": "A String", # Output only. The date and time that the Autonomous Database was created.
"database": "A String", # Optional. 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.
"displayName": "A String", # Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the Autonomous Database.
"labels": { # Optional. The labels or tags associated with the Autonomous Database.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
"network": "A String", # Required. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}
"properties": { # The properties of an Autonomous Database. # Optional. The properties of the Autonomous Database.
"actualUsedDataStorageSizeTb": 3.14, # Output only. The amount of storage currently being used for user and system data, in terabytes.
"allocatedStorageSizeTb": 3.14, # Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.
"apexDetails": { # Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex # Output only. The details for the Oracle APEX Application Development.
"apexVersion": "A String", # Output only. The Oracle APEX Application Development version.
"ordsVersion": "A String", # Output only. The Oracle REST Data Services (ORDS) version.
},
"arePrimaryAllowlistedIpsUsed": True or False, # 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.
"autonomousContainerDatabaseId": "A String", # Output only. The Autonomous Container Database OCID.
"availableUpgradeVersions": [ # Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.
"A String",
],
"backupRetentionPeriodDays": 42, # Optional. 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.
"characterSet": "A String", # Optional. The character set for the Autonomous Database. The default is AL32UTF8.
"computeCount": 3.14, # Optional. The number of compute servers for the Autonomous Database.
"connectionStrings": { # The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings # Output only. The connection strings used to connect to an Autonomous Database.
"allConnectionStrings": { # A list of all connection strings that can be used to connect to the Autonomous Database. # Output only. Returns all connection strings that can be used to connect to the Autonomous Database.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
},
"dedicated": "A String", # Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.
"high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
"low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
"medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
"profiles": [ # Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.
{ # The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile
"consumerGroup": "A String", # Output only. The current consumer group being used by the connection.
"displayName": "A String", # Output only. The display name for the database connection.
"hostFormat": "A String", # Output only. The host name format being currently used in connection string.
"isRegional": True or False, # Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.
"protocol": "A String", # Output only. The protocol being used by the connection.
"sessionMode": "A String", # Output only. The current session mode of the connection.
"syntaxFormat": "A String", # Output only. The syntax of the connection string.
"tlsAuthentication": "A String", # Output only. This field indicates the TLS authentication type of the connection.
"value": "A String", # Output only. The value of the connection string.
},
],
},
"connectionUrls": { # 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 # Output only. The Oracle Connection URLs for an Autonomous Database.
"apexUri": "A String", # Output only. Oracle Application Express (APEX) URL.
"databaseTransformsUri": "A String", # Output only. The URL of the Database Transforms for the Autonomous Database.
"graphStudioUri": "A String", # Output only. The URL of the Graph Studio for the Autonomous Database.
"machineLearningNotebookUri": "A String", # Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.
"machineLearningUserManagementUri": "A String", # Output only. The URL of Machine Learning user management the Autonomous Database.
"mongoDbUri": "A String", # Output only. The URL of the MongoDB API for the Autonomous Database.
"ordsUri": "A String", # Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.
"sqlDevWebUri": "A String", # Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.
},
"cpuCoreCount": 42, # Optional. The number of CPU cores to be made available to the database.
"customerContacts": [ # Optional. The list of customer contacts.
{ # The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact
"email": "A String", # Required. The email address used by Oracle to send notifications regarding databases and infrastructure.
},
],
"dataSafeState": "A String", # Output only. The current state of the Data Safe registration for the Autonomous Database.
"dataStorageSizeGb": 42, # Optional. The size of the data stored in the database, in gigabytes.
"dataStorageSizeTb": 42, # Optional. The size of the data stored in the database, in terabytes.
"databaseManagementState": "A String", # Output only. The current state of database management for the Autonomous Database.
"dbEdition": "A String", # Optional. The edition of the Autonomous Databases.
"dbVersion": "A String", # Optional. The Oracle Database version for the Autonomous Database.
"dbWorkload": "A String", # Required. The workload type of the Autonomous Database.
"failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover.
"isAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.
"isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.
"isStorageAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.
"licenseType": "A String", # Required. The license type used for the Autonomous Database.
"lifecycleDetails": "A String", # Output only. The details of the current lifestyle state of the Autonomous Database.
"localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.
"localDisasterRecoveryType": "A String", # Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.
"localStandbyDb": { # Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary # Output only. The details of the Autonomous Data Guard standby database.
"dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.
"disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
"lagTimeDuration": "A String", # 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.
"lifecycleDetails": "A String", # Output only. The additional details about the current lifecycle state of the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
},
"maintenanceBeginTime": "A String", # Output only. The date and time when maintenance will begin.
"maintenanceEndTime": "A String", # Output only. The date and time when maintenance will end.
"maintenanceScheduleType": "A String", # Optional. The maintenance schedule of the Autonomous Database.
"memoryPerOracleComputeUnitGbs": 42, # Output only. The amount of memory enabled per ECPU, in gigabytes.
"memoryTableGbs": 42, # Output only. The memory assigned to in-memory tables in an Autonomous Database.
"mtlsConnectionRequired": True or False, # Optional. This field specifies if the Autonomous Database requires mTLS connections.
"nCharacterSet": "A String", # Optional. The national character set for the Autonomous Database. The default is AL16UTF16.
"nextLongTermBackupTime": "A String", # Output only. The long term backup schedule of the Autonomous Database.
"ociUrl": "A String", # Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.
"ocid": "A String", # Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
"openMode": "A String", # Output only. This field indicates the current mode of the Autonomous Database.
"operationsInsightsState": "A String", # Output only. This field indicates the state of Operations Insights for the Autonomous Database.
"peerDbIds": [ # Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.
"A String",
],
"permissionLevel": "A String", # Output only. The permission level of the Autonomous Database.
"privateEndpoint": "A String", # Output only. The private endpoint for the Autonomous Database.
"privateEndpointIp": "A String", # Optional. The private endpoint IP address for the Autonomous Database.
"privateEndpointLabel": "A String", # Optional. The private endpoint label for the Autonomous Database.
"refreshableMode": "A String", # Output only. The refresh mode of the cloned Autonomous Database.
"refreshableState": "A String", # Output only. The refresh State of the clone.
"role": "A String", # Output only. The Data Guard role of the Autonomous Database.
"scheduledOperationDetails": [ # Output only. The list and details of the scheduled operations of the Autonomous Database.
{ # Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails
"dayOfWeek": "A String", # Output only. Day of week.
"startTime": { # 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`. # Output only. Auto start time.
"hours": 42, # 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.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # 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.
},
"stopTime": { # 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`. # Output only. Auto stop time.
"hours": 42, # 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.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # 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.
},
},
],
"secretId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault secret.
"sqlWebDeveloperUrl": "A String", # Output only. The SQL Web Developer URL for the Autonomous Database.
"state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
"supportedCloneRegions": [ # Output only. The list of available regions that can be used to create a clone for the Autonomous Database.
"A String",
],
"totalAutoBackupStorageSizeGbs": 3.14, # Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.
"usedDataStorageSizeTbs": 42, # Output only. The storage space used by Autonomous Database, in gigabytes.
"vaultId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault.
},
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
restore(name, body=None, x__xgafv=None)
Restores a single Autonomous Database.
Args:
name: string, Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
body: object, The request body.
The object takes the form of:
{ # The request for `AutonomousDatabase.Restore`.
"restoreTime": "A String", # Required. The time and date to restore the database to.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}