Skip to content

Commit

Permalink
feat(sqladmin): update the api
Browse files Browse the repository at this point in the history 
#### sqladmin:v1

The following keys were added:
- resources.instances.methods.demote (Total Keys: 14)
- schemas.DemoteContext (Total Keys: 4)
- schemas.InstancesDemoteRequest (Total Keys: 3)

#### sqladmin:v1beta4

The following keys were added:
- resources.instances.methods.demote (Total Keys: 14)
- schemas.DemoteContext (Total Keys: 4)
- schemas.InstancesDemoteRequest (Total Keys: 3)
  • Loading branch information
@yoshi-automation
yoshi-automation committed Nov 7, 2023
1 parent 4a43e59 commit ffada26
Show file tree
Hide file tree
Showing 4 changed files with 376 additions and 6 deletions.
120 changes: 120 additions & 0 deletions docs/dyn/sqladmin_v1.instances.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(project, instance, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a Cloud SQL instance.</p>
<p class="toc_element">
<code><a href="#demote">demote(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.</p>
<p class="toc_element">
<code><a href="#demoteMaster">demoteMaster(project, instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.</p>
Expand Down Expand Up @@ -498,6 +501,123 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="demote">demote(project, instance, body=None, x__xgafv=None)</code>
<pre>Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.

Args:
project: string, Required. ID of the project that contains the instance. (required)
instance: string, Required. Cloud SQL instance name. (required)
body: object, The request body.
The object takes the form of:

{ # This request is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.
&quot;demoteContext&quot;: { # This context is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server. # Required. Contains details about the demote operation.
&quot;kind&quot;: &quot;A String&quot;, # This is always `sql#demoteContext`.
&quot;sourceRepresentativeInstanceName&quot;: &quot;A String&quot;, # Required. The name of the instance which acts as the on-premises primary instance in the replication setup.
},
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
&quot;backupContext&quot;: { # Backup context. # The context for backup operation, if applicable.
&quot;backupId&quot;: &quot;A String&quot;, # The identifier of the backup.
&quot;kind&quot;: &quot;A String&quot;, # This is always `sql#backupContext`.
},
&quot;endTime&quot;: &quot;A String&quot;, # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
&quot;error&quot;: { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
&quot;errors&quot;: [ # The list of errors encountered while processing this operation.
{ # Database instance operation error.
&quot;code&quot;: &quot;A String&quot;, # Identifies the specific error that occurred.
&quot;kind&quot;: &quot;A String&quot;, # This is always `sql#operationError`.
&quot;message&quot;: &quot;A String&quot;, # Additional information about the error encountered.
},
],
&quot;kind&quot;: &quot;A String&quot;, # This is always `sql#operationErrors`.
},
&quot;exportContext&quot;: { # Database instance export context. # The context for export operation, if applicable.
&quot;bakExportOptions&quot;: { # Options for exporting BAK files (SQL Server-only)
&quot;bakType&quot;: &quot;A String&quot;, # Type of this bak file will be export, FULL or DIFF, SQL Server only
&quot;copyOnly&quot;: True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
&quot;differentialBase&quot;: True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
&quot;stripeCount&quot;: 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
&quot;striped&quot;: True or False, # Whether or not the export should be striped.
},
&quot;csvExportOptions&quot;: { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
&quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
&quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
&quot;linesTerminatedBy&quot;: &quot;A String&quot;, # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
&quot;quoteCharacter&quot;: &quot;A String&quot;, # Specifies the quoting character to be used when a data value is quoted.
&quot;selectQuery&quot;: &quot;A String&quot;, # The select query used to extract the data.
},
&quot;databases&quot;: [ # Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
&quot;A String&quot;,
],
&quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri.
&quot;kind&quot;: &quot;A String&quot;, # This is always `sql#exportContext`.
&quot;offload&quot;: True or False, # Option for export offload.
&quot;sqlExportOptions&quot;: { # Options for exporting data as SQL statements.
&quot;mysqlExportOptions&quot;: { # Options for exporting from MySQL.
&quot;masterData&quot;: 42, # Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.
},
&quot;schemaOnly&quot;: True or False, # Export only schemas.
&quot;tables&quot;: [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
&quot;A String&quot;,
],
},
&quot;uri&quot;: &quot;A String&quot;, # 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 request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
},
&quot;importContext&quot;: { # Database instance import context. # The context for import operation, if applicable.
&quot;bakImportOptions&quot;: { # Import parameters specific to SQL Server .BAK files
&quot;bakType&quot;: &quot;A String&quot;, # Type of the bak content, FULL or DIFF
&quot;encryptionOptions&quot;: {
&quot;certPath&quot;: &quot;A String&quot;, # Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
&quot;pvkPassword&quot;: &quot;A String&quot;, # Password that encrypts the private key
&quot;pvkPath&quot;: &quot;A String&quot;, # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
},
&quot;noRecovery&quot;: True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
&quot;recoveryOnly&quot;: True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of &quot;no_recovery&quot; and &quot;recovery_only&quot; can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
&quot;stopAt&quot;: &quot;A String&quot;, # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
&quot;stopAtMark&quot;: &quot;A String&quot;, # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
&quot;striped&quot;: True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
},
&quot;csvImportOptions&quot;: { # Options for importing data as CSV.
&quot;columns&quot;: [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
&quot;A String&quot;,
],
&quot;escapeCharacter&quot;: &quot;A String&quot;, # Specifies the character that should appear before a data character that needs to be escaped.
&quot;fieldsTerminatedBy&quot;: &quot;A String&quot;, # Specifies the character that separates columns within each row (line) of the file.
&quot;linesTerminatedBy&quot;: &quot;A String&quot;, # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
&quot;quoteCharacter&quot;: &quot;A String&quot;, # Specifies the quoting character to be used when a data value is quoted.
&quot;table&quot;: &quot;A String&quot;, # The table to which CSV data is imported.
},
&quot;database&quot;: &quot;A String&quot;, # The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified.
&quot;fileType&quot;: &quot;A String&quot;, # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
&quot;importUser&quot;: &quot;A String&quot;, # The PostgreSQL user for this import operation. PostgreSQL instances only.
&quot;kind&quot;: &quot;A String&quot;, # This is always `sql#importContext`.
&quot;uri&quot;: &quot;A String&quot;, # Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
},
&quot;insertTime&quot;: &quot;A String&quot;, # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
&quot;kind&quot;: &quot;A String&quot;, # This is always `sql#operation`.
&quot;name&quot;: &quot;A String&quot;, # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
&quot;operationType&quot;: &quot;A String&quot;, # 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`
&quot;selfLink&quot;: &quot;A String&quot;, # The URI of this resource.
&quot;startTime&quot;: &quot;A String&quot;, # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
&quot;status&quot;: &quot;A String&quot;, # The status of an operation.
&quot;targetId&quot;: &quot;A String&quot;, # Name of the database instance related to this operation.
&quot;targetLink&quot;: &quot;A String&quot;,
&quot;targetProject&quot;: &quot;A String&quot;, # The project ID of the target instance related to this operation.
&quot;user&quot;: &quot;A String&quot;, # The email address of the user who initiated this operation.
}</pre>
</div>

<div class="method">
<code class="details" id="demoteMaster">demoteMaster(project, instance, body=None, x__xgafv=None)</code>
<pre>Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.
Expand Down

0 comments on commit ffada26

Please sign in to comment.