gogol-sqladmin-0.0.1: Google Cloud SQL Administration SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.SQLAdmin.Types

Contents

Description

 

Synopsis

Service Configuration

sQLAdminService :: Service Source

Default request referring to version v1beta4 of the Cloud SQL Administration API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

sqlserviceAdminScope :: OAuthScope Source

Manage your Google SQL Service instances

cloudPlatformScope :: OAuthScope Source

View and manage your data across Google Cloud Platform services

SSLCert

data SSLCert Source

SslCerts Resource

See: sslCert smart constructor.

Instances

sslCert :: SSLCert Source

Creates a value of SSLCert with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

scCommonName :: Lens' SSLCert (Maybe Text) Source

User supplied name. Constrained to [a-zA-Z.-_ ]+.

scKind :: Lens' SSLCert Text Source

This is always sql#sslCert.

scCertSerialNumber :: Lens' SSLCert (Maybe Text) Source

Serial number, as extracted from the certificate.

scSelfLink :: Lens' SSLCert (Maybe Text) Source

The URI of this resource.

scCert :: Lens' SSLCert (Maybe Text) Source

PEM representation.

scSha1Fingerprint :: Lens' SSLCert (Maybe Text) Source

Sha1 Fingerprint.

scExpirationTime :: Lens' SSLCert (Maybe UTCTime) Source

The time when the certificate expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

scCreateTime :: Lens' SSLCert (Maybe UTCTime) Source

The time when the certificate was created in RFC 3339 format, for example 2012-11-15T16:19:00.094Z

scInstance :: Lens' SSLCert (Maybe Text) Source

Name of the database instance.

DatabasesListResponse

data DatabasesListResponse Source

Database list response.

See: databasesListResponse smart constructor.

Instances

databasesListResponse :: DatabasesListResponse Source

Creates a value of DatabasesListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dlrKind :: Lens' DatabasesListResponse Text Source

This is always sql#databasesList.

dlrItems :: Lens' DatabasesListResponse [Database] Source

List of database resources in the instance.

InstancesExportRequest

data InstancesExportRequest Source

Database instance export request.

See: instancesExportRequest smart constructor.

Instances

instancesExportRequest :: InstancesExportRequest Source

Creates a value of InstancesExportRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ierExportContext :: Lens' InstancesExportRequest (Maybe ExportContext) Source

Contains details about the export operation.

OnPremisesConfiguration

data OnPremisesConfiguration Source

On-premises instance configuration.

See: onPremisesConfiguration smart constructor.

Instances

onPremisesConfiguration :: OnPremisesConfiguration Source

Creates a value of OnPremisesConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

opcKind :: Lens' OnPremisesConfiguration Text Source

This is always sql#onPremisesConfiguration.

opcHostPort :: Lens' OnPremisesConfiguration (Maybe Text) Source

The host and port of the on-premises instance in host:port format

OperationsListResponse

data OperationsListResponse Source

Database instance list operations response.

See: operationsListResponse smart constructor.

Instances

operationsListResponse :: OperationsListResponse Source

Creates a value of OperationsListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

olrNextPageToken :: Lens' OperationsListResponse (Maybe Text) Source

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

olrKind :: Lens' OperationsListResponse Text Source

This is always sql#operationsList.

olrItems :: Lens' OperationsListResponse [Operation] Source

List of operation resources.

ImportContext

data ImportContext Source

Database instance import context.

See: importContext smart constructor.

Instances

importContext :: ImportContext Source

Creates a value of ImportContext with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

icDatabase :: Lens' ImportContext (Maybe Text) Source

The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.

icKind :: Lens' ImportContext Text Source

This is always sql#importContext.

icCSVImportOptions :: Lens' ImportContext (Maybe ImportContextCSVImportOptions) Source

Options for importing data as CSV.

icURI :: Lens' ImportContext (Maybe Text) Source

A path to the file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL.

icFileType :: Lens' ImportContext (Maybe Text) Source

The file type for the specified uri. SQL: The file contains SQL statements. CSV: The file contains CSV data.

Operation

data Operation Source

An Operations resource contains information about database instance operations such as create, delete, and restart. Operations resources are created in response to operations that were initiated; you never create them directly.

See: operation smart constructor.

Instances

operation :: Operation Source

Creates a value of Operation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

oTargetId :: Lens' Operation (Maybe Text) Source

Name of the database instance related to this operation.

oTargetProject :: Lens' Operation (Maybe Text) Source

The project ID of the target instance related to this operation.

oStatus :: Lens' Operation (Maybe Text) Source

The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.

oInsertTime :: Lens' Operation (Maybe UTCTime) Source

The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

oImportContext :: Lens' Operation (Maybe ImportContext) Source

The context for import operation, if applicable.

oStartTime :: Lens' Operation (Maybe UTCTime) Source

The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

oKind :: Lens' Operation Text Source

This is always sql#operation.

oError :: Lens' Operation (Maybe OperationErrors) Source

If errors occurred during processing of this operation, this field will be populated.

oExportContext :: Lens' Operation (Maybe ExportContext) Source

The context for export operation, if applicable.

oUser :: Lens' Operation (Maybe Text) Source

The email address of the user who initiated this operation.

oSelfLink :: Lens' Operation (Maybe Text) Source

The URI of this resource.

oName :: Lens' Operation (Maybe Text) Source

An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

oEndTime :: Lens' Operation (Maybe UTCTime) Source

The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

oOperationType :: Lens' Operation (Maybe Text) Source

The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .

oTargetLink :: Lens' Operation (Maybe Text) Source

The URI of the instance related to the operation.

Settings

data Settings Source

Database instance settings.

See: settings smart constructor.

Instances

settings :: Settings Source

Creates a value of Settings with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sReplicationType :: Lens' Settings (Maybe Text) Source

The type of replication this instance uses. This can be either ASYNCHRONOUS or SYNCHRONOUS.

sActivationPolicy :: Lens' Settings (Maybe Text) Source

The activation policy for this instance. This specifies when the instance should be activated and is applicable only when the instance state is RUNNABLE. This can be one of the following. ALWAYS: The instance should always be active. NEVER: The instance should never be activated. ON_DEMAND: The instance is activated upon receiving requests.

sSettingsVersion :: Lens' Settings (Maybe Int64) Source

The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.

sDataDiskSizeGb :: Lens' Settings (Maybe Int64) Source

The size of data disk for the performance instance, specified in GB. Setting this value for non-performance instances will result in an error.

sAuthorizedGaeApplications :: Lens' Settings [Text] Source

The App Engine app IDs that can access this instance.

sKind :: Lens' Settings Text Source

This is always sql#settings.

sPricingPlan :: Lens' Settings (Maybe Text) Source

The pricing plan for this instance. This can be either PER_USE or PACKAGE.

sIPConfiguration :: Lens' Settings (Maybe IPConfiguration) Source

The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance.

sDatabaseReplicationEnabled :: Lens' Settings (Maybe Bool) Source

Configuration specific to read replica instances. Indicates whether replication is enabled or not.

sTier :: Lens' Settings (Maybe Text) Source

The tier of service for this instance, for example D1, D2. For more information, see pricing.

sDatabaseFlags :: Lens' Settings [DatabaseFlags] Source

The database flags passed to the instance at startup.

sCrashSafeReplicationEnabled :: Lens' Settings (Maybe Bool) Source

Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled.

sLocationPreference :: Lens' Settings (Maybe LocationPreference) Source

The location preference settings. This allows the instance to be located as near as possible to either an App Engine app or GCE zone for better performance.

sBackupConfiguration :: Lens' Settings (Maybe BackupConfiguration) Source

The daily backup configuration for the instance.

IPMApping

data IPMApping Source

Database instance IP Mapping.

See: ipMApping smart constructor.

Instances

ipMApping :: IPMApping Source

Creates a value of IPMApping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

imaIPAddress :: Lens' IPMApping (Maybe Text) Source

The IP address assigned.

imaTimeToRetire :: Lens' IPMApping (Maybe UTCTime) Source

The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.

Database

data Database Source

A database resource inside a Cloud SQL instance.

See: database smart constructor.

Instances

database :: Database Source

Creates a value of Database with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dEtag :: Lens' Database (Maybe Text) Source

HTTP 1.1 Entity tag for the resource.

dProject :: Lens' Database (Maybe Text) Source

The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable.

dKind :: Lens' Database Text Source

This is always sql#database.

dCollation :: Lens' Database (Maybe Text) Source

The MySQL collation value.

dSelfLink :: Lens' Database (Maybe Text) Source

The URI of this resource.

dName :: Lens' Database (Maybe Text) Source

The name of the database in the Cloud SQL instance. This does not include the project ID or instance name.

dCharSet :: Lens' Database (Maybe Text) Source

The MySQL charset value.

dInstance :: Lens' Database (Maybe Text) Source

The name of the Cloud SQL instance. This does not include the project ID.

SSLCertsCreateEphemeralRequest

data SSLCertsCreateEphemeralRequest Source

SslCerts create ephemeral certificate request.

See: sslCertsCreateEphemeralRequest smart constructor.

Instances

sslCertsCreateEphemeralRequest :: SSLCertsCreateEphemeralRequest Source

Creates a value of SSLCertsCreateEphemeralRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sccerPublicKey :: Lens' SSLCertsCreateEphemeralRequest (Maybe Text) Source

PEM encoded public key to include in the signed certificate.

BinLogCoordinates

data BinLogCoordinates Source

Binary log coordinates.

See: binLogCoordinates smart constructor.

Instances

binLogCoordinates :: BinLogCoordinates Source

Creates a value of BinLogCoordinates with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

blcBinLogPosition :: Lens' BinLogCoordinates (Maybe Int64) Source

Position (offset) within the binary log file.

blcKind :: Lens' BinLogCoordinates Text Source

This is always sql#binLogCoordinates.

blcBinLogFileName :: Lens' BinLogCoordinates (Maybe Text) Source

Name of the binary log file for a Cloud SQL instance.

TiersListResponse

data TiersListResponse Source

Tiers list response.

See: tiersListResponse smart constructor.

Instances

tiersListResponse :: TiersListResponse Source

Creates a value of TiersListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tlrKind :: Lens' TiersListResponse Text Source

This is always sql#tiersList.

tlrItems :: Lens' TiersListResponse [Tier] Source

List of tiers.

UsersListResponse

data UsersListResponse Source

User list response.

See: usersListResponse smart constructor.

Instances

usersListResponse :: UsersListResponse Source

Creates a value of UsersListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ulrNextPageToken :: Lens' UsersListResponse (Maybe Text) Source

An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

ulrKind :: Lens' UsersListResponse Text Source

This is always sql#usersList.

ulrItems :: Lens' UsersListResponse [User] Source

List of user resources in the instance.

ExportContext

data ExportContext Source

Database instance export context.

See: exportContext smart constructor.

Instances

exportContext :: ExportContext Source

Creates a value of ExportContext with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ecCSVExportOptions :: Lens' ExportContext (Maybe ExportContextCSVExportOptions) Source

Options for exporting data as CSV.

ecKind :: Lens' ExportContext Text Source

This is always sql#exportContext.

ecURI :: Lens' ExportContext (Maybe Text) Source

The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.

ecFileType :: Lens' ExportContext (Maybe Text) Source

The file type for the specified uri. SQL: The file contains SQL statements. CSV: The file contains CSV data.

ecSQLExportOptions :: Lens' ExportContext (Maybe ExportContextSQLExportOptions) Source

Options for exporting data as SQL statements.

ecDatabases :: Lens' ExportContext [Text] Source

Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.

OperationErrors

data OperationErrors Source

Database instance operation errors list wrapper.

See: operationErrors smart constructor.

Instances

operationErrors :: OperationErrors Source

Creates a value of OperationErrors with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

oeKind :: Lens' OperationErrors Text Source

This is always sql#operationErrors.

oeErrors :: Lens' OperationErrors [OperationError] Source

The list of errors encountered while processing this operation.

SSLCertsListResponse

data SSLCertsListResponse Source

SslCerts list response.

See: sslCertsListResponse smart constructor.

Instances

sslCertsListResponse :: SSLCertsListResponse Source

Creates a value of SSLCertsListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sclrKind :: Lens' SSLCertsListResponse Text Source

This is always sql#sslCertsList.

sclrItems :: Lens' SSLCertsListResponse [SSLCert] Source

List of client certificates for the instance.

SSLCertsInsertRequest

data SSLCertsInsertRequest Source

SslCerts insert request.

See: sslCertsInsertRequest smart constructor.

Instances

sslCertsInsertRequest :: SSLCertsInsertRequest Source

Creates a value of SSLCertsInsertRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

scirCommonName :: Lens' SSLCertsInsertRequest (Maybe Text) Source

User supplied name. Must be a distinct name from the other certificates for this instance. New certificates will not be usable until the instance is restarted.

IPConfiguration

data IPConfiguration Source

IP Management configuration.

See: ipConfiguration smart constructor.

Instances

ipConfiguration :: IPConfiguration Source

Creates a value of IPConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

icAuthorizedNetworks :: Lens' IPConfiguration [ACLEntry] Source

The list of external networks that are allowed to connect to the instance using the IP. In CIDR notation, also known as 'slash' notation (e.g. 192.168.100.0/24).

icRequireSSL :: Lens' IPConfiguration (Maybe Bool) Source

Whether the mysqld should default to 'REQUIRE X509' for users connecting over IP.

icIPv4Enabled :: Lens' IPConfiguration (Maybe Bool) Source

Whether the instance should be assigned an IP address or not.

ImportContextCSVImportOptions

data ImportContextCSVImportOptions Source

Options for importing data as CSV.

See: importContextCSVImportOptions smart constructor.

Instances

importContextCSVImportOptions :: ImportContextCSVImportOptions Source

Creates a value of ImportContextCSVImportOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

iccioColumns :: Lens' ImportContextCSVImportOptions [Text] Source

The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.

iccioTable :: Lens' ImportContextCSVImportOptions (Maybe Text) Source

The table to which CSV data is imported.

ExportContextCSVExportOptions

data ExportContextCSVExportOptions Source

Options for exporting data as CSV.

See: exportContextCSVExportOptions smart constructor.

Instances

exportContextCSVExportOptions :: ExportContextCSVExportOptions Source

Creates a value of ExportContextCSVExportOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ecceoSelectQuery :: Lens' ExportContextCSVExportOptions (Maybe Text) Source

The select query used to extract the data.

User

data User Source

A Cloud SQL user resource.

See: user smart constructor.

Instances

user :: User Source

Creates a value of User with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

uEtag :: Lens' User (Maybe Text) Source

HTTP 1.1 Entity tag for the resource.

uProject :: Lens' User (Maybe Text) Source

The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for update since it is already specified on the URL.

uKind :: Lens' User Text Source

This is always sql#user.

uName :: Lens' User (Maybe Text) Source

The name of the user in the Cloud SQL instance. Can be omitted for update since it is already specified on the URL.

uPassword :: Lens' User (Maybe Text) Source

The password for the user.

uHost :: Lens' User (Maybe Text) Source

The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name is not mutable with this API.

uInstance :: Lens' User (Maybe Text) Source

The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for update since it is already specified on the URL.

DatabaseInstance

data DatabaseInstance Source

A Cloud SQL instance resource.

See: databaseInstance smart constructor.

Instances

databaseInstance :: DatabaseInstance Source

Creates a value of DatabaseInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

datMaxDiskSize :: Lens' DatabaseInstance (Maybe Int64) Source

The maximum disk size of the instance in bytes.

datOnPremisesConfiguration :: Lens' DatabaseInstance (Maybe OnPremisesConfiguration) Source

Configuration specific to on-premises instances.

datEtag :: Lens' DatabaseInstance (Maybe Text) Source

HTTP 1.1 Entity tag for the resource.

datState :: Lens' DatabaseInstance (Maybe Text) Source

The current serving state of the Cloud SQL instance. This can be one of the following. RUNNABLE: The instance is running, or is ready to run when accessed. SUSPENDED: The instance is not available, for example due to problems with billing. PENDING_CREATE: The instance is being created. MAINTENANCE: The instance is down for maintenance. FAILED: The instance creation failed. UNKNOWN_STATE: The state of the instance is unknown.

datIPv6Address :: Lens' DatabaseInstance (Maybe Text) Source

The IPv6 address assigned to the instance.

datServerCaCert :: Lens' DatabaseInstance (Maybe SSLCert) Source

SSL configuration.

datDatabaseVersion :: Lens' DatabaseInstance (Maybe Text) Source

The database engine type and version. Can be MYSQL_5_5 or MYSQL_5_6. Defaults to MYSQL_5_5. The databaseVersion can not be changed after instance creation.

datProject :: Lens' DatabaseInstance (Maybe Text) Source

The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.

datSettings :: Lens' DatabaseInstance (Maybe Settings) Source

The user settings.

datKind :: Lens' DatabaseInstance Text Source

This is always sql#instance.

datCurrentDiskSize :: Lens' DatabaseInstance (Maybe Int64) Source

The current disk usage of the instance in bytes.

datInstanceType :: Lens' DatabaseInstance (Maybe Text) Source

The instance type. This can be one of the following. CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. ON_PREMISES_INSTANCE: An instance running on the customer's premises. READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica.

datReplicaNames :: Lens' DatabaseInstance [Text] Source

The replicas of the instance.

datSelfLink :: Lens' DatabaseInstance (Maybe Text) Source

The URI of this resource.

datName :: Lens' DatabaseInstance (Maybe Text) Source

Name of the Cloud SQL instance. This does not include the project ID.

datMasterInstanceName :: Lens' DatabaseInstance (Maybe Text) Source

The name of the instance which will act as master in the replication setup.

datReplicaConfiguration :: Lens' DatabaseInstance (Maybe ReplicaConfiguration) Source

Configuration specific to read-replicas replicating from on-premises masters.

datRegion :: Lens' DatabaseInstance (Maybe Text) Source

The geographical region. Can be us-central, asia-east1 or europe-west1. Defaults to us-central. The region can not be changed after instance creation.

datServiceAccountEmailAddress :: Lens' DatabaseInstance (Maybe Text) Source

The service account email address assigned to the instance.

datIPAddresses :: Lens' DatabaseInstance [IPMApping] Source

The assigned IP addresses for the instance.

CloneContext

data CloneContext Source

Database instance clone context.

See: cloneContext smart constructor.

Instances

cloneContext :: CloneContext Source

Creates a value of CloneContext with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ccDestinationInstanceName :: Lens' CloneContext (Maybe Text) Source

Name of the Cloud SQL instance to be created as a clone.

ccBinLogCoordinates :: Lens' CloneContext (Maybe BinLogCoordinates) Source

Binary log coordinates, if specified, indentify the the position up to which the source instance should be cloned. If not specified, the source instance is cloned up to the most recent binary log coordintes.

ccKind :: Lens' CloneContext Text Source

This is always sql#cloneContext.

Flag

data Flag Source

A Google Cloud SQL service flag resource.

See: flag smart constructor.

Instances

flag :: Flag Source

Creates a value of Flag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fMaxValue :: Lens' Flag (Maybe Int64) Source

For INTEGER flags, the maximum allowed value.

fKind :: Lens' Flag Text Source

This is always sql#flag.

fAppliesTo :: Lens' Flag [Text] Source

The database version this flag applies to. Can be MYSQL_5_5, MYSQL_5_6, or both.

fName :: Lens' Flag (Maybe Text) Source

This is the name of the flag. Flag names always use underscores, not hyphens, e.g. max_allowed_packet

fAllowedStringValues :: Lens' Flag [Text] Source

For STRING flags, a list of strings that the value can be set to.

fType :: Lens' Flag (Maybe Text) Source

The type of the flag. Flags are typed to being BOOLEAN, STRING, INTEGER or NONE. NONE is used for flags which do not take a value, such as skip_grant_tables.

fMinValue :: Lens' Flag (Maybe Int64) Source

For INTEGER flags, the minimum allowed value.

InstancesFailoverRequest

data InstancesFailoverRequest Source

Instance failover request.

See: instancesFailoverRequest smart constructor.

Instances

instancesFailoverRequest :: InstancesFailoverRequest Source

Creates a value of InstancesFailoverRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ifrFailoverContext :: Lens' InstancesFailoverRequest (Maybe FailoverContext) Source

Failover Context.

BackupRun

data BackupRun Source

A database instance backup run resource.

See: backupRun smart constructor.

Instances

backupRun :: BackupRun Source

Creates a value of BackupRun with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

brStatus :: Lens' BackupRun (Maybe Text) Source

The status of this run.

brStartTime :: Lens' BackupRun (Maybe UTCTime) Source

The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

brKind :: Lens' BackupRun Text Source

This is always sql#backupRun.

brError :: Lens' BackupRun (Maybe OperationError) Source

Information about why the backup operation failed. This is only present if the run has the FAILED status.

brWindowStartTime :: Lens' BackupRun (Maybe UTCTime) Source

The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

brSelfLink :: Lens' BackupRun (Maybe Text) Source

The URI of this resource.

brEndTime :: Lens' BackupRun (Maybe UTCTime) Source

The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

brId :: Lens' BackupRun (Maybe Int64) Source

A unique identifier for this backup run. Note that this is unique only within the scope of a particular Cloud SQL instance.

brEnqueuedTime :: Lens' BackupRun (Maybe UTCTime) Source

The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

brInstance :: Lens' BackupRun (Maybe Text) Source

Name of the database instance.

ACLEntry

data ACLEntry Source

An entry for an Access Control list.

See: aclEntry smart constructor.

Instances

aclEntry :: ACLEntry Source

Creates a value of ACLEntry with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aeKind :: Lens' ACLEntry Text Source

This is always sql#aclEntry.

aeValue :: Lens' ACLEntry (Maybe Text) Source

The whitelisted value for the access control list.

aeName :: Lens' ACLEntry (Maybe Text) Source

An optional label to identify this entry.

aeExpirationTime :: Lens' ACLEntry (Maybe UTCTime) Source

The time when this access control entry expires in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

DatabaseFlags

data DatabaseFlags Source

MySQL flags for Cloud SQL instances.

See: databaseFlags smart constructor.

Instances

databaseFlags :: DatabaseFlags Source

Creates a value of DatabaseFlags with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dfValue :: Lens' DatabaseFlags (Maybe Text) Source

The value of the flag. Booleans should be set to on for true and off for false. This field must be omitted if the flag doesn't take a value.

dfName :: Lens' DatabaseFlags (Maybe Text) Source

The name of the flag. These flags are passed at instance startup, so include both MySQL server options and MySQL system variables. Flags should be specified with underscores, not hyphens. For more information, see Configuring MySQL Flags in the Google Cloud SQL documentation, as well as the official MySQL documentation for server options and system variables.

Tier

data Tier Source

A Google Cloud SQL service tier resource.

See: tier smart constructor.

Instances

tier :: Tier Source

Creates a value of Tier with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tKind :: Lens' Tier Text Source

This is always sql#tier.

tTier :: Lens' Tier (Maybe Text) Source

An identifier for the service tier, for example D1, D2 etc. For related information, see Pricing.

tRegion :: Lens' Tier [Text] Source

The applicable regions for this tier. Can be us-east1, europe-west1 or asia-east1.

tDiskQuota :: Lens' Tier (Maybe Int64) Source

The maximum disk size of this tier in bytes.

tRAM :: Lens' Tier (Maybe Int64) Source

The maximum RAM usage of this tier in bytes.

MySQLReplicaConfiguration

data MySQLReplicaConfiguration Source

Read-replica configuration specific to MySQL databases.

See: mySQLReplicaConfiguration smart constructor.

Instances

mySQLReplicaConfiguration :: MySQLReplicaConfiguration Source

Creates a value of MySQLReplicaConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

msqlrcVerifyServerCertificate :: Lens' MySQLReplicaConfiguration (Maybe Bool) Source

Whether or not to check the master's Common Name value in the certificate that it sends during the SSL handshake.

msqlrcKind :: Lens' MySQLReplicaConfiguration Text Source

This is always sql#mysqlReplicaConfiguration.

msqlrcClientKey :: Lens' MySQLReplicaConfiguration (Maybe Text) Source

PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate.

msqlrcUsername :: Lens' MySQLReplicaConfiguration (Maybe Text) Source

The username for the replication connection.

msqlrcSSLCipher :: Lens' MySQLReplicaConfiguration (Maybe Text) Source

A list of permissible ciphers to use for SSL encryption.

msqlrcMasterHeartbeatPeriod :: Lens' MySQLReplicaConfiguration (Maybe Int64) Source

Interval in milliseconds between replication heartbeats.

msqlrcConnectRetryInterval :: Lens' MySQLReplicaConfiguration (Maybe Int32) Source

Seconds to wait between connect retries. MySQL's default is 60 seconds.

msqlrcClientCertificate :: Lens' MySQLReplicaConfiguration (Maybe Text) Source

PEM representation of the slave's x509 certificate.

msqlrcCaCertificate :: Lens' MySQLReplicaConfiguration (Maybe Text) Source

PEM representation of the trusted CA's x509 certificate.

msqlrcDumpFilePath :: Lens' MySQLReplicaConfiguration (Maybe Text) Source

Path to a SQL dump file in Google Cloud Storage from which the slave instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps should have the binlog co-ordinates from which replication should begin. This can be accomplished by setting --master-data to 1 when using mysqldump.

msqlrcPassword :: Lens' MySQLReplicaConfiguration (Maybe Text) Source

The password for the replication connection.

SSLCertDetail

data SSLCertDetail Source

SslCertDetail.

See: sslCertDetail smart constructor.

Instances

sslCertDetail :: SSLCertDetail Source

Creates a value of SSLCertDetail with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

scdCertInfo :: Lens' SSLCertDetail (Maybe SSLCert) Source

The public information about the cert.

scdCertPrivateKey :: Lens' SSLCertDetail (Maybe Text) Source

The private key for the client cert, in pem format. Keep private in order to protect your security.

InstancesRestoreBackupRequest

data InstancesRestoreBackupRequest Source

Database instance restore backup request.

See: instancesRestoreBackupRequest smart constructor.

Instances

instancesRestoreBackupRequest :: InstancesRestoreBackupRequest Source

Creates a value of InstancesRestoreBackupRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

irbrRestoreBackupContext :: Lens' InstancesRestoreBackupRequest (Maybe RestoreBackupContext) Source

Parameters required to perform the restore backup operation.

BackupRunsListResponse

data BackupRunsListResponse Source

Backup run list results.

See: backupRunsListResponse smart constructor.

Instances

backupRunsListResponse :: BackupRunsListResponse Source

Creates a value of BackupRunsListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

brlrNextPageToken :: Lens' BackupRunsListResponse (Maybe Text) Source

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

brlrKind :: Lens' BackupRunsListResponse Text Source

This is always sql#backupRunsList.

brlrItems :: Lens' BackupRunsListResponse [BackupRun] Source

A list of backup runs in reverse chronological order of the enqueued time.

OperationError

data OperationError Source

Database instance operation error.

See: operationError smart constructor.

Instances

operationError :: OperationError Source

Creates a value of OperationError with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

opeKind :: Lens' OperationError Text Source

This is always sql#operationError.

opeCode :: Lens' OperationError (Maybe Text) Source

Identifies the specific error that occurred.

opeMessage :: Lens' OperationError (Maybe Text) Source

Additional information about the error encountered.

InstancesCloneRequest

data InstancesCloneRequest Source

Database instance clone request.

See: instancesCloneRequest smart constructor.

Instances

instancesCloneRequest :: InstancesCloneRequest Source

Creates a value of InstancesCloneRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

icrCloneContext :: Lens' InstancesCloneRequest (Maybe CloneContext) Source

Contains details about the clone operation.

ReplicaConfiguration

data ReplicaConfiguration Source

Read-replica configuration for connecting to the master.

See: replicaConfiguration smart constructor.

Instances

replicaConfiguration :: ReplicaConfiguration Source

Creates a value of ReplicaConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rcFailoverTarget :: Lens' ReplicaConfiguration (Maybe Bool) Source

Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance.

rcKind :: Lens' ReplicaConfiguration Text Source

This is always sql#replicaConfiguration.

rcMysqlReplicaConfiguration :: Lens' ReplicaConfiguration (Maybe MySQLReplicaConfiguration) Source

MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory.

FailoverContext

data FailoverContext Source

Database instance failover context.

See: failoverContext smart constructor.

Instances

failoverContext :: FailoverContext Source

Creates a value of FailoverContext with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fcSettingsVersion :: Lens' FailoverContext (Maybe Int64) Source

The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version.

fcKind :: Lens' FailoverContext Text Source

This is always sql#failoverContext.

SSLCertsInsertResponse

data SSLCertsInsertResponse Source

SslCert insert response.

See: sslCertsInsertResponse smart constructor.

Instances

sslCertsInsertResponse :: SSLCertsInsertResponse Source

Creates a value of SSLCertsInsertResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

scirServerCaCert :: Lens' SSLCertsInsertResponse (Maybe SSLCert) Source

The server Certificate Authority's certificate. If this is missing you can force a new one to be generated by calling resetSslConfig method on instances resource.

scirKind :: Lens' SSLCertsInsertResponse Text Source

This is always sql#sslCertsInsert.

scirClientCert :: Lens' SSLCertsInsertResponse (Maybe SSLCertDetail) Source

The new client certificate and private key. The new certificate will not work until the instance is restarted.

InstancesListResponse

data InstancesListResponse Source

Database instances list response.

See: instancesListResponse smart constructor.

Instances

instancesListResponse :: InstancesListResponse Source

Creates a value of InstancesListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ilrNextPageToken :: Lens' InstancesListResponse (Maybe Text) Source

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

ilrKind :: Lens' InstancesListResponse Text Source

This is always sql#instancesList.

ilrItems :: Lens' InstancesListResponse [DatabaseInstance] Source

List of database instance resources.

BackupConfiguration

data BackupConfiguration Source

Database instance backup configuration.

See: backupConfiguration smart constructor.

Instances

backupConfiguration :: BackupConfiguration Source

Creates a value of BackupConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bcEnabled :: Lens' BackupConfiguration (Maybe Bool) Source

Whether this configuration is enabled.

bcStartTime :: Lens' BackupConfiguration (Maybe Text) Source

Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.

bcKind :: Lens' BackupConfiguration Text Source

This is always sql#backupConfiguration.

bcBinaryLogEnabled :: Lens' BackupConfiguration (Maybe Bool) Source

Whether binary log is enabled. If backup configuration is disabled, binary log must be disabled as well.

InstancesImportRequest

data InstancesImportRequest Source

Database instance import request.

See: instancesImportRequest smart constructor.

Instances

instancesImportRequest :: InstancesImportRequest Source

Creates a value of InstancesImportRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

iirImportContext :: Lens' InstancesImportRequest (Maybe ImportContext) Source

Contains details about the import operation.

LocationPreference

data LocationPreference Source

Preferred location. This specifies where a Cloud SQL instance should preferably be located, either in a specific Compute Engine zone, or co-located with an App Engine application. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.

See: locationPreference smart constructor.

Instances

locationPreference :: LocationPreference Source

Creates a value of LocationPreference with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lpKind :: Lens' LocationPreference Text Source

This is always sql#locationPreference.

lpFollowGaeApplication :: Lens' LocationPreference (Maybe Text) Source

The AppEngine application to follow, it must be in the same region as the Cloud SQL instance.

lpZone :: Lens' LocationPreference (Maybe Text) Source

The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.).

FlagsListResponse

data FlagsListResponse Source

Flags list response.

See: flagsListResponse smart constructor.

Instances

flagsListResponse :: FlagsListResponse Source

Creates a value of FlagsListResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

flrKind :: Lens' FlagsListResponse Text Source

This is always sql#flagsList.

flrItems :: Lens' FlagsListResponse [Flag] Source

List of flags.

ExportContextSQLExportOptions

data ExportContextSQLExportOptions Source

Options for exporting data as SQL statements.

See: exportContextSQLExportOptions smart constructor.

Instances

exportContextSQLExportOptions :: ExportContextSQLExportOptions Source

Creates a value of ExportContextSQLExportOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ecsqleoSchemaOnly :: Lens' ExportContextSQLExportOptions (Maybe Bool) Source

Export only schemas.

ecsqleoTables :: Lens' ExportContextSQLExportOptions [Text] Source

Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.

RestoreBackupContext

data RestoreBackupContext Source

Database instance restore from backup context.

See: restoreBackupContext smart constructor.

Instances

restoreBackupContext :: RestoreBackupContext Source

Creates a value of RestoreBackupContext with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rbcInstanceId :: Lens' RestoreBackupContext (Maybe Text) Source

The ID of the instance that the backup was taken from.

rbcBackupRunId :: Lens' RestoreBackupContext (Maybe Int64) Source

The ID of the backup run to restore from.

rbcKind :: Lens' RestoreBackupContext Text Source

This is always sql#restoreBackupContext.