sqladmin

package
v0.183.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 4, 2024 License: BSD-3-Clause Imports: 16 Imported by: 315

Documentation

Overview

Package sqladmin provides access to the Cloud SQL Admin API.

For product documentation, see: https://developers.google.com/cloud-sql/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/sqladmin/v1beta4"
...
ctx := context.Background()
sqladminService, err := sqladmin.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes: 

sqladminService, err := sqladmin.NewService(ctx, option.WithScopes(sqladmin.SqlserviceAdminScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

sqladminService, err := sqladmin.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
sqladminService, err := sqladmin.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// Manage your Google SQL Service instances
	SqlserviceAdminScope = "https://www.googleapis.com/auth/sqlservice.admin"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AclEntry 

type AclEntry struct {
	// ExpirationTime: The time when this access control entry expires in RFC 3339
	// (https://tools.ietf.org/html/rfc3339) format, for example
	// `2012-11-15T16:19:00.094Z`.
	ExpirationTime string `json:"expirationTime,omitempty"`
	// Kind: This is always `sql#aclEntry`.
	Kind string `json:"kind,omitempty"`
	// Name: Optional. A label to identify this entry.
	Name string `json:"name,omitempty"`
	// Value: The allowlisted value for the access control list.
	Value string `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExpirationTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExpirationTime") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AclEntry: An entry for an Access Control list.

func (*AclEntry) MarshalJSON 

func (s *AclEntry) MarshalJSON() ([]byte, error)

type AcquireSsrsLeaseContext added in v0.170.0 

type AcquireSsrsLeaseContext struct {
	// Duration: Lease duration needed for the SSRS setup.
	Duration string `json:"duration,omitempty"`
	// ReportDatabase: The report database to be used for the SSRS setup.
	ReportDatabase string `json:"reportDatabase,omitempty"`
	// ServiceLogin: The username to be used as the service login to connect to the
	// report database for SSRS setup.
	ServiceLogin string `json:"serviceLogin,omitempty"`
	// SetupLogin: The username to be used as the setup login to connect to the
	// database server for SSRS setup.
	SetupLogin string `json:"setupLogin,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Duration") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Duration") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AcquireSsrsLeaseContext: Acquire SSRS lease context.

func (*AcquireSsrsLeaseContext) MarshalJSON added in v0.170.0 

func (s *AcquireSsrsLeaseContext) MarshalJSON() ([]byte, error)

type AdvancedMachineFeatures added in v0.117.0 

type AdvancedMachineFeatures struct {
	// ThreadsPerCore: The number of threads per physical core.
	ThreadsPerCore int64 `json:"threadsPerCore,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ThreadsPerCore") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ThreadsPerCore") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AdvancedMachineFeatures: Specifies options for controlling advanced machine features.

func (*AdvancedMachineFeatures) MarshalJSON added in v0.117.0 

func (s *AdvancedMachineFeatures) MarshalJSON() ([]byte, error)

type ApiWarning 

type ApiWarning struct {
	// Code: Code to uniquely identify the warning type.
	//
	// Possible values:
	//   "SQL_API_WARNING_CODE_UNSPECIFIED" - An unknown or unset warning type from
	// Cloud SQL API.
	//   "REGION_UNREACHABLE" - Warning when one or more regions are not reachable.
	// The returned result set may be incomplete.
	//   "MAX_RESULTS_EXCEEDS_LIMIT" - Warning when user provided maxResults
	// parameter exceeds the limit. The returned result set may be incomplete.
	//   "COMPROMISED_CREDENTIALS" - Warning when user tries to create/update a
	// user with credentials that have previously been compromised by a public data
	// breach.
	//   "INTERNAL_STATE_FAILURE" - Warning when the operation succeeds but some
	// non-critical workflow state failed.
	Code string `json:"code,omitempty"`
	// Message: The warning message.
	Message string `json:"message,omitempty"`
	// Region: The region name for REGION_UNREACHABLE warning.
	Region string `json:"region,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ApiWarning: An Admin API warning message.

func (*ApiWarning) MarshalJSON 

func (s *ApiWarning) MarshalJSON() ([]byte, error)

type AvailableDatabaseVersion added in v0.182.0 

type AvailableDatabaseVersion struct {
	// DisplayName: The database version's display name.
	DisplayName string `json:"displayName,omitempty"`
	// MajorVersion: The version's major version name.
	MajorVersion string `json:"majorVersion,omitempty"`
	// Name: The database version name. For MySQL 8.0, this string provides the
	// database major and minor version.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AvailableDatabaseVersion: An available database version. It can be a major or a minor version.

func (*AvailableDatabaseVersion) MarshalJSON added in v0.182.0 

func (s *AvailableDatabaseVersion) MarshalJSON() ([]byte, error)

type BackupConfiguration 

type BackupConfiguration struct {
	// BackupRetentionSettings: Backup retention settings.
	BackupRetentionSettings *BackupRetentionSettings `json:"backupRetentionSettings,omitempty"`
	// BinaryLogEnabled: (MySQL only) Whether binary log is enabled. If backup
	// configuration is disabled, binarylog must be disabled as well.
	BinaryLogEnabled bool `json:"binaryLogEnabled,omitempty"`
	// Enabled: Whether this configuration is enabled.
	Enabled bool `json:"enabled,omitempty"`
	// Kind: This is always `sql#backupConfiguration`.
	Kind string `json:"kind,omitempty"`
	// Location: Location of the backup
	Location string `json:"location,omitempty"`
	// PointInTimeRecoveryEnabled: Whether point in time recovery is enabled.
	PointInTimeRecoveryEnabled bool `json:"pointInTimeRecoveryEnabled,omitempty"`
	// ReplicationLogArchivingEnabled: Reserved for future use.
	ReplicationLogArchivingEnabled bool `json:"replicationLogArchivingEnabled,omitempty"`
	// StartTime: Start time for the daily backup configuration in UTC timezone in
	// the 24 hour format - `HH:MM`.
	StartTime string `json:"startTime,omitempty"`
	// TransactionLogRetentionDays: The number of days of transaction logs we
	// retain for point in time restore, from 1-7.
	TransactionLogRetentionDays int64 `json:"transactionLogRetentionDays,omitempty"`
	// TransactionalLogStorageState: Output only. This value contains the storage
	// location of transactional logs for the database for point-in-time recovery.
	//
	// Possible values:
	//   "TRANSACTIONAL_LOG_STORAGE_STATE_UNSPECIFIED" - Unspecified.
	//   "DISK" - The transaction logs used for PITR for the instance are stored on
	// a data disk.
	//   "SWITCHING_TO_CLOUD_STORAGE" - The transaction logs used for PITR for the
	// instance are switching from being stored on a data disk to being stored in
	// Cloud Storage. Only applicable to MySQL.
	//   "SWITCHED_TO_CLOUD_STORAGE" - The transaction logs used for PITR for the
	// instance are now stored in Cloud Storage. Previously, they were stored on a
	// data disk. Only applicable to MySQL.
	//   "CLOUD_STORAGE" - The transaction logs used for PITR for the instance are
	// stored in Cloud Storage. Only applicable to MySQL and PostgreSQL.
	TransactionalLogStorageState string `json:"transactionalLogStorageState,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BackupRetentionSettings") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackupRetentionSettings") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BackupConfiguration: Database instance backup configuration.

func (*BackupConfiguration) MarshalJSON 

func (s *BackupConfiguration) MarshalJSON() ([]byte, error)

type BackupContext added in v0.36.0 

type BackupContext struct {
	// BackupId: The identifier of the backup.
	BackupId int64 `json:"backupId,omitempty,string"`
	// Kind: This is always `sql#backupContext`.
	Kind string `json:"kind,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BackupId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackupId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BackupContext: Backup context.

func (*BackupContext) MarshalJSON added in v0.36.0 

func (s *BackupContext) MarshalJSON() ([]byte, error)

type BackupReencryptionConfig added in v0.128.0 

type BackupReencryptionConfig struct {
	// BackupLimit: Backup re-encryption limit
	BackupLimit int64 `json:"backupLimit,omitempty"`
	// BackupType: Type of backups users want to re-encrypt.
	//
	// Possible values:
	//   "BACKUP_TYPE_UNSPECIFIED" - Unknown backup type, will be defaulted to
	// AUTOMATIC backup type
	//   "AUTOMATED" - Reencrypt automatic backups
	//   "ON_DEMAND" - Reencrypt on-demand backups
	BackupType string `json:"backupType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BackupLimit") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackupLimit") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BackupReencryptionConfig: Backup Reencryption Config

func (*BackupReencryptionConfig) MarshalJSON added in v0.128.0 

func (s *BackupReencryptionConfig) MarshalJSON() ([]byte, error)

type BackupRetentionSettings added in v0.33.0 

type BackupRetentionSettings struct {
	// RetainedBackups: Depending on the value of retention_unit, this is used to
	// determine if a backup needs to be deleted. If retention_unit is 'COUNT', we
	// will retain this many backups.
	RetainedBackups int64 `json:"retainedBackups,omitempty"`
	// RetentionUnit: The unit that 'retained_backups' represents.
	//
	// Possible values:
	//   "RETENTION_UNIT_UNSPECIFIED" - Backup retention unit is unspecified, will
	// be treated as COUNT.
	//   "COUNT" - Retention will be by count, eg. "retain the most recent 7
	// backups".
	RetentionUnit string `json:"retentionUnit,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RetainedBackups") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "RetainedBackups") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BackupRetentionSettings: We currently only support backup retention by specifying the number of backups we will retain.

func (*BackupRetentionSettings) MarshalJSON added in v0.33.0 

func (s *BackupRetentionSettings) MarshalJSON() ([]byte, error)

type BackupRun 

type BackupRun struct {
	// BackupKind: Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
	//
	// Possible values:
	//   "SQL_BACKUP_KIND_UNSPECIFIED" - This is an unknown BackupKind.
	//   "SNAPSHOT" - The snapshot based backups
	//   "PHYSICAL" - Physical backups
	BackupKind string `json:"backupKind,omitempty"`
	// Description: The description of this run, only applicable to on-demand
	// backups.
	Description string `json:"description,omitempty"`
	// DiskEncryptionConfiguration: Encryption configuration specific to a backup.
	DiskEncryptionConfiguration *DiskEncryptionConfiguration `json:"diskEncryptionConfiguration,omitempty"`
	// DiskEncryptionStatus: Encryption status specific to a backup.
	DiskEncryptionStatus *DiskEncryptionStatus `json:"diskEncryptionStatus,omitempty"`
	// EndTime: The time the backup operation completed in UTC timezone in RFC 3339
	// (https://tools.ietf.org/html/rfc3339) format, for example
	// `2012-11-15T16:19:00.094Z`.
	EndTime string `json:"endTime,omitempty"`
	// EnqueuedTime: The time the run was enqueued in UTC timezone in RFC 3339
	// (https://tools.ietf.org/html/rfc3339) format, for example
	// `2012-11-15T16:19:00.094Z`.
	EnqueuedTime string `json:"enqueuedTime,omitempty"`
	// Error: Information about why the backup operation failed. This is only
	// present if the run has the FAILED status.
	Error *OperationError `json:"error,omitempty"`
	// Id: The identifier for this backup run. Unique only for a specific Cloud SQL
	// instance.
	Id int64 `json:"id,omitempty,string"`
	// Instance: Name of the database instance.
	Instance string `json:"instance,omitempty"`
	// Kind: This is always `sql#backupRun`.
	Kind string `json:"kind,omitempty"`
	// Location: Location of the backups.
	Location string `json:"location,omitempty"`
	// SelfLink: The URI of this resource.
	SelfLink string `json:"selfLink,omitempty"`
	// StartTime: The time the backup operation actually started in UTC timezone in
	// RFC 3339 (https://tools.ietf.org/html/rfc3339) format, for example
	// `2012-11-15T16:19:00.094Z`.
	StartTime string `json:"startTime,omitempty"`
	// Status: The status of this run.
	//
	// Possible values:
	//   "SQL_BACKUP_RUN_STATUS_UNSPECIFIED" - The status of the run is unknown.
	//   "ENQUEUED" - The backup operation was enqueued.
	//   "OVERDUE" - The backup is overdue across a given backup window. Indicates
	// a problem. Example: Long-running operation in progress during the whole
	// window.
	//   "RUNNING" - The backup is in progress.
	//   "FAILED" - The backup failed.
	//   "SUCCESSFUL" - The backup was successful.
	//   "SKIPPED" - The backup was skipped (without problems) for a given backup
	// window. Example: Instance was idle.
	//   "DELETION_PENDING" - The backup is about to be deleted.
	//   "DELETION_FAILED" - The backup deletion failed.
	//   "DELETED" - The backup has been deleted.
	Status string `json:"status,omitempty"`
	// TimeZone: Backup time zone to prevent restores to an instance with a
	// different time zone. Now relevant only for SQL Server.
	TimeZone string `json:"timeZone,omitempty"`
	// Type: The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or
	// "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified
	// for insert requests.
	//
	// Possible values:
	//   "SQL_BACKUP_RUN_TYPE_UNSPECIFIED" - This is an unknown BackupRun type.
	//   "AUTOMATED" - The backup schedule automatically triggers a backup.
	//   "ON_DEMAND" - The user manually triggers a backup.
	Type string `json:"type,omitempty"`
	// WindowStartTime: The start time of the backup window during which this the
	// backup was attempted in RFC 3339 (https://tools.ietf.org/html/rfc3339)
	// format, for example `2012-11-15T16:19:00.094Z`.
	WindowStartTime string `json:"windowStartTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "BackupKind") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackupKind") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BackupRun: A BackupRun resource.

func (*BackupRun) MarshalJSON 

func (s *BackupRun) MarshalJSON() ([]byte, error)

type BackupRunsDeleteCall 

type BackupRunsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*BackupRunsDeleteCall) Context 

func (c *BackupRunsDeleteCall) Context(ctx context.Context) *BackupRunsDeleteCall

Context sets the context to be used in this call's Do method.

func (*BackupRunsDeleteCall) Do 

func (c *BackupRunsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.backupRuns.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BackupRunsDeleteCall) Fields 

func (c *BackupRunsDeleteCall) Fields(s ...googleapi.Field) *BackupRunsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BackupRunsDeleteCall) Header 

func (c *BackupRunsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type BackupRunsGetCall 

type BackupRunsGetCall struct {
	// contains filtered or unexported fields
}

func (*BackupRunsGetCall) Context 

func (c *BackupRunsGetCall) Context(ctx context.Context) *BackupRunsGetCall

Context sets the context to be used in this call's Do method.

func (*BackupRunsGetCall) Do 

func (c *BackupRunsGetCall) Do(opts ...googleapi.CallOption) (*BackupRun, error)

Do executes the "sql.backupRuns.get" call. Any non-2xx status code is an error. Response headers are in either *BackupRun.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BackupRunsGetCall) Fields 

func (c *BackupRunsGetCall) Fields(s ...googleapi.Field) *BackupRunsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BackupRunsGetCall) Header 

func (c *BackupRunsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*BackupRunsGetCall) IfNoneMatch 

func (c *BackupRunsGetCall) IfNoneMatch(entityTag string) *BackupRunsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type BackupRunsInsertCall 

type BackupRunsInsertCall struct {
	// contains filtered or unexported fields
}

func (*BackupRunsInsertCall) Context 

func (c *BackupRunsInsertCall) Context(ctx context.Context) *BackupRunsInsertCall

Context sets the context to be used in this call's Do method.

func (*BackupRunsInsertCall) Do 

func (c *BackupRunsInsertCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.backupRuns.insert" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BackupRunsInsertCall) Fields 

func (c *BackupRunsInsertCall) Fields(s ...googleapi.Field) *BackupRunsInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BackupRunsInsertCall) Header 

func (c *BackupRunsInsertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type BackupRunsListCall 

type BackupRunsListCall struct {
	// contains filtered or unexported fields
}

func (*BackupRunsListCall) Context 

func (c *BackupRunsListCall) Context(ctx context.Context) *BackupRunsListCall

Context sets the context to be used in this call's Do method.

func (*BackupRunsListCall) Do 

func (c *BackupRunsListCall) Do(opts ...googleapi.CallOption) (*BackupRunsListResponse, error)

Do executes the "sql.backupRuns.list" call. Any non-2xx status code is an error. Response headers are in either *BackupRunsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BackupRunsListCall) Fields 

func (c *BackupRunsListCall) Fields(s ...googleapi.Field) *BackupRunsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BackupRunsListCall) Header 

func (c *BackupRunsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*BackupRunsListCall) IfNoneMatch 

func (c *BackupRunsListCall) IfNoneMatch(entityTag string) *BackupRunsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*BackupRunsListCall) MaxResults 

func (c *BackupRunsListCall) MaxResults(maxResults int64) *BackupRunsListCall

MaxResults sets the optional parameter "maxResults": Maximum number of backup runs per response.

func (*BackupRunsListCall) PageToken 

func (c *BackupRunsListCall) PageToken(pageToken string) *BackupRunsListCall

PageToken sets the optional parameter "pageToken": A previously-returned page token representing part of the larger set of results to view.

func (*BackupRunsListCall) Pages 

func (c *BackupRunsListCall) Pages(ctx context.Context, f func(*BackupRunsListResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type BackupRunsListResponse 

type BackupRunsListResponse struct {
	// Items: A list of backup runs in reverse chronological order of the enqueued
	// time.
	Items []*BackupRun `json:"items,omitempty"`
	// Kind: This is always `sql#backupRunsList`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: The continuation token, used to page through large result
	// sets. Provide this value in a subsequent request to return the next page of
	// results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Items") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BackupRunsListResponse: Backup run list results.

func (*BackupRunsListResponse) MarshalJSON 

func (s *BackupRunsListResponse) MarshalJSON() ([]byte, error)

type BackupRunsService 

type BackupRunsService struct {
	// contains filtered or unexported fields
}

func NewBackupRunsService 

func NewBackupRunsService(s *Service) *BackupRunsService

func (*BackupRunsService) Delete 

func (r *BackupRunsService) Delete(project string, instance string, id int64) *BackupRunsDeleteCall

Delete: Deletes the backup taken by a backup run.

func (*BackupRunsService) Get 

func (r *BackupRunsService) Get(project string, instance string, id int64) *BackupRunsGetCall

Get: Retrieves a resource containing information about a backup run.

- id: The ID of this backup run. - instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*BackupRunsService) Insert 

func (r *BackupRunsService) Insert(project string, instance string, backuprun *BackupRun) *BackupRunsInsertCall

Insert: Creates a new backup run on demand.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*BackupRunsService) List 

func (r *BackupRunsService) List(project string, instance string) *BackupRunsListCall

List: Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.

  • instance: Cloud SQL instance ID, or "-" for all instances. This does not include the project ID.
  • project: Project ID of the project that contains the instance.

type BinLogCoordinates 

type BinLogCoordinates struct {
	// BinLogFileName: Name of the binary log file for a Cloud SQL instance.
	BinLogFileName string `json:"binLogFileName,omitempty"`
	// BinLogPosition: Position (offset) within the binary log file.
	BinLogPosition int64 `json:"binLogPosition,omitempty,string"`
	// Kind: This is always `sql#binLogCoordinates`.
	Kind string `json:"kind,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BinLogFileName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BinLogFileName") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BinLogCoordinates: Binary log coordinates.

func (*BinLogCoordinates) MarshalJSON 

func (s *BinLogCoordinates) MarshalJSON() ([]byte, error)

type CloneContext 

type CloneContext struct {
	// AllocatedIpRange: The name of the allocated ip range for the private ip
	// Cloud SQL instance. For example: "google-managed-services-default". If set,
	// the cloned instance ip will be created in the allocated range. The range
	// name must comply with RFC 1035 (https://tools.ietf.org/html/rfc1035).
	// Specifically, the name must be 1-63 characters long and match the regular
	// expression a-z ([-a-z0-9]*[a-z0-9])?. Reserved for future use.
	AllocatedIpRange string `json:"allocatedIpRange,omitempty"`
	// BinLogCoordinates: Binary log coordinates, if specified, identify the
	// position up to which the source instance is cloned. If not specified, the
	// source instance is cloned up to the most recent binary log coordinates.
	BinLogCoordinates *BinLogCoordinates `json:"binLogCoordinates,omitempty"`
	// DatabaseNames: (SQL Server only) Clone only the specified databases from the
	// source instance. Clone all databases if empty.
	DatabaseNames []string `json:"databaseNames,omitempty"`
	// DestinationInstanceName: Name of the Cloud SQL instance to be created as a
	// clone.
	DestinationInstanceName string `json:"destinationInstanceName,omitempty"`
	// Kind: This is always `sql#cloneContext`.
	Kind string `json:"kind,omitempty"`
	// PitrTimestampMs: Reserved for future use.
	PitrTimestampMs int64 `json:"pitrTimestampMs,omitempty,string"`
	// PointInTime: Timestamp, if specified, identifies the time to which the
	// source instance is cloned.
	PointInTime string `json:"pointInTime,omitempty"`
	// PreferredSecondaryZone: Optional. Copy clone and point-in-time recovery
	// clone of a regional instance in the specified zones. If not specified, clone
	// to the same secondary zone as the source instance. This value cannot be the
	// same as the preferred_zone field.
	PreferredSecondaryZone string `json:"preferredSecondaryZone,omitempty"`
	// PreferredZone: Optional. Copy clone and point-in-time recovery clone of an
	// instance to the specified zone. If no zone is specified, clone to the same
	// primary zone as the source instance.
	PreferredZone string `json:"preferredZone,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllocatedIpRange") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllocatedIpRange") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CloneContext: Database instance clone context.

func (*CloneContext) MarshalJSON 

func (s *CloneContext) MarshalJSON() ([]byte, error)

type ConnectGenerateEphemeralCertCall added in v0.51.0 

type ConnectGenerateEphemeralCertCall struct {
	// contains filtered or unexported fields
}

func (*ConnectGenerateEphemeralCertCall) Context added in v0.51.0 

func (c *ConnectGenerateEphemeralCertCall) Context(ctx context.Context) *ConnectGenerateEphemeralCertCall

Context sets the context to be used in this call's Do method.

func (*ConnectGenerateEphemeralCertCall) Do added in v0.51.0 

func (c *ConnectGenerateEphemeralCertCall) Do(opts ...googleapi.CallOption) (*GenerateEphemeralCertResponse, error)

Do executes the "sql.connect.generateEphemeral" call. Any non-2xx status code is an error. Response headers are in either *GenerateEphemeralCertResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ConnectGenerateEphemeralCertCall) Fields added in v0.51.0 

func (c *ConnectGenerateEphemeralCertCall) Fields(s ...googleapi.Field) *ConnectGenerateEphemeralCertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ConnectGenerateEphemeralCertCall) Header added in v0.51.0 

func (c *ConnectGenerateEphemeralCertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ConnectGetCall added in v0.51.0 

type ConnectGetCall struct {
	// contains filtered or unexported fields
}

func (*ConnectGetCall) Context added in v0.51.0 

func (c *ConnectGetCall) Context(ctx context.Context) *ConnectGetCall

Context sets the context to be used in this call's Do method.

func (*ConnectGetCall) Do added in v0.51.0 

func (c *ConnectGetCall) Do(opts ...googleapi.CallOption) (*ConnectSettings, error)

Do executes the "sql.connect.get" call. Any non-2xx status code is an error. Response headers are in either *ConnectSettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ConnectGetCall) Fields added in v0.51.0 

func (c *ConnectGetCall) Fields(s ...googleapi.Field) *ConnectGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ConnectGetCall) Header added in v0.51.0 

func (c *ConnectGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ConnectGetCall) IfNoneMatch added in v0.51.0 

func (c *ConnectGetCall) IfNoneMatch(entityTag string) *ConnectGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ConnectGetCall) ReadTime added in v0.51.0 

func (c *ConnectGetCall) ReadTime(readTime string) *ConnectGetCall

ReadTime sets the optional parameter "readTime": Optional snapshot read timestamp to trade freshness for performance.

type ConnectService added in v0.51.0 

type ConnectService struct {
	// contains filtered or unexported fields
}

func NewConnectService added in v0.51.0 

func NewConnectService(s *Service) *ConnectService

func (*ConnectService) GenerateEphemeralCert added in v0.51.0 

func (r *ConnectService) GenerateEphemeralCert(project string, instance string, generateephemeralcertrequest *GenerateEphemeralCertRequest) *ConnectGenerateEphemeralCertCall

GenerateEphemeralCert: Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*ConnectService) Get added in v0.51.0 

func (r *ConnectService) Get(project string, instance string) *ConnectGetCall

Get: Retrieves connect settings about a Cloud SQL instance.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

type ConnectSettings added in v0.51.0 

type ConnectSettings struct {
	// BackendType: `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A
	// database server that is not managed by Google. This property is read-only;
	// use the `tier` property in the `settings` object to determine the database
	// type.
	//
	// Possible values:
	//   "SQL_BACKEND_TYPE_UNSPECIFIED" - This is an unknown backend type for
	// instance.
	//   "FIRST_GEN" - V1 speckle instance.
	//   "SECOND_GEN" - V2 speckle instance.
	//   "EXTERNAL" - On premises instance.
	BackendType string `json:"backendType,omitempty"`
	// DatabaseVersion: The database engine type and version. The `databaseVersion`
	// field cannot be changed after instance creation. MySQL instances:
	// `MYSQL_8_0`, `MYSQL_5_7` (default), or `MYSQL_5_6`. PostgreSQL instances:
	// `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11` or `POSTGRES_12` (default),
	// `POSTGRES_13`, or `POSTGRES_14`. SQL Server instances:
	// `SQLSERVER_2017_STANDARD` (default), `SQLSERVER_2017_ENTERPRISE`,
	// `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`,
	// `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or
	// `SQLSERVER_2019_WEB`.
	//
	// Possible values:
	//   "SQL_DATABASE_VERSION_UNSPECIFIED" - This is an unknown database version.
	//   "MYSQL_5_1" - The database version is MySQL 5.1.
	//   "MYSQL_5_5" - The database version is MySQL 5.5.
	//   "MYSQL_5_6" - The database version is MySQL 5.6.
	//   "MYSQL_5_7" - The database version is MySQL 5.7.
	//   "SQLSERVER_2017_STANDARD" - The database version is SQL Server 2017
	// Standard.
	//   "SQLSERVER_2017_ENTERPRISE" - The database version is SQL Server 2017
	// Enterprise.
	//   "SQLSERVER_2017_EXPRESS" - The database version is SQL Server 2017
	// Express.
	//   "SQLSERVER_2017_WEB" - The database version is SQL Server 2017 Web.
	//   "POSTGRES_9_6" - The database version is PostgreSQL 9.6.
	//   "POSTGRES_10" - The database version is PostgreSQL 10.
	//   "POSTGRES_11" - The database version is PostgreSQL 11.
	//   "POSTGRES_12" - The database version is PostgreSQL 12.
	//   "POSTGRES_13" - The database version is PostgreSQL 13.
	//   "POSTGRES_14" - The database version is PostgreSQL 14.
	//   "POSTGRES_15" - The database version is PostgreSQL 15.
	//   "POSTGRES_16" - The database version is PostgreSQL 16.
	//   "MYSQL_8_0" - The database version is MySQL 8.
	//   "MYSQL_8_0_18" - The database major version is MySQL 8.0 and the minor
	// version is 18.
	//   "MYSQL_8_0_26" - The database major version is MySQL 8.0 and the minor
	// version is 26.
	//   "MYSQL_8_0_27" - The database major version is MySQL 8.0 and the minor
	// version is 27.
	//   "MYSQL_8_0_28" - The database major version is MySQL 8.0 and the minor
	// version is 28.
	//   "MYSQL_8_0_29" - The database major version is MySQL 8.0 and the minor
	// version is 29.
	//   "MYSQL_8_0_30" - The database major version is MySQL 8.0 and the minor
	// version is 30.
	//   "MYSQL_8_0_31" - The database major version is MySQL 8.0 and the minor
	// version is 31.
	//   "MYSQL_8_0_32" - The database major version is MySQL 8.0 and the minor
	// version is 32.
	//   "MYSQL_8_0_33" - The database major version is MySQL 8.0 and the minor
	// version is 33.
	//   "MYSQL_8_0_34" - The database major version is MySQL 8.0 and the minor
	// version is 34.
	//   "MYSQL_8_0_35" - The database major version is MySQL 8.0 and the minor
	// version is 35.
	//   "MYSQL_8_0_36" - The database major version is MySQL 8.0 and the minor
	// version is 36.
	//   "MYSQL_8_0_37" - The database major version is MySQL 8.0 and the minor
	// version is 37.
	//   "MYSQL_8_0_38" - The database major version is MySQL 8.0 and the minor
	// version is 38.
	//   "MYSQL_8_0_39" - The database major version is MySQL 8.0 and the minor
	// version is 39.
	//   "MYSQL_8_0_40" - The database major version is MySQL 8.0 and the minor
	// version is 40.
	//   "MYSQL_8_4" - The database version is MySQL 8.4.
	//   "MYSQL_8_4_0" - The database version is MySQL 8.4 and the patch version is
	// 0.
	//   "SQLSERVER_2019_STANDARD" - The database version is SQL Server 2019
	// Standard.
	//   "SQLSERVER_2019_ENTERPRISE" - The database version is SQL Server 2019
	// Enterprise.
	//   "SQLSERVER_2019_EXPRESS" - The database version is SQL Server 2019
	// Express.
	//   "SQLSERVER_2019_WEB" - The database version is SQL Server 2019 Web.
	//   "SQLSERVER_2022_STANDARD" - The database version is SQL Server 2022
	// Standard.
	//   "SQLSERVER_2022_ENTERPRISE" - The database version is SQL Server 2022
	// Enterprise.
	//   "SQLSERVER_2022_EXPRESS" - The database version is SQL Server 2022
	// Express.
	//   "SQLSERVER_2022_WEB" - The database version is SQL Server 2022 Web.
	DatabaseVersion string `json:"databaseVersion,omitempty"`
	// DnsName: The dns name of the instance.
	DnsName string `json:"dnsName,omitempty"`
	// IpAddresses: The assigned IP addresses for the instance.
	IpAddresses []*IpMapping `json:"ipAddresses,omitempty"`
	// Kind: This is always `sql#connectSettings`.
	Kind string `json:"kind,omitempty"`
	// PscEnabled: Whether PSC connectivity is enabled for this instance.
	PscEnabled bool `json:"pscEnabled,omitempty"`
	// Region: The cloud region for the instance. e.g. `us-central1`,
	// `europe-west1`. The region cannot be changed after instance creation.
	Region string `json:"region,omitempty"`
	// ServerCaCert: SSL configuration.
	ServerCaCert *SslCert `json:"serverCaCert,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "BackendType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackendType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ConnectSettings: Connect settings retrieval response.

func (*ConnectSettings) MarshalJSON added in v0.51.0 

func (s *ConnectSettings) MarshalJSON() ([]byte, error)

type DataCacheConfig added in v0.130.0 

type DataCacheConfig struct {
	// DataCacheEnabled: Whether data cache is enabled for the instance.
	DataCacheEnabled bool `json:"dataCacheEnabled,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DataCacheEnabled") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DataCacheEnabled") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataCacheConfig: Data cache configurations.

func (*DataCacheConfig) MarshalJSON added in v0.130.0 

func (s *DataCacheConfig) MarshalJSON() ([]byte, error)

type Database 

type Database struct {
	// Charset: The Cloud SQL charset value.
	Charset string `json:"charset,omitempty"`
	// Collation: The Cloud SQL collation value.
	Collation string `json:"collation,omitempty"`
	// Etag: This field is deprecated and will be removed from a future version of
	// the API.
	Etag string `json:"etag,omitempty"`
	// Instance: The name of the Cloud SQL instance. This does not include the
	// project ID.
	Instance string `json:"instance,omitempty"`
	// Kind: This is always `sql#database`.
	Kind string `json:"kind,omitempty"`
	// Name: The name of the database in the Cloud SQL instance. This does not
	// include the project ID or instance name.
	Name string `json:"name,omitempty"`
	// Project: The project ID of the project containing the Cloud SQL database.
	// The Google apps domain is prefixed if applicable.
	Project string `json:"project,omitempty"`
	// SelfLink: The URI of this resource.
	SelfLink                 string                    `json:"selfLink,omitempty"`
	SqlserverDatabaseDetails *SqlServerDatabaseDetails `json:"sqlserverDatabaseDetails,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Charset") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Charset") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Database: Represents a SQL database on the Cloud SQL instance.

func (*Database) MarshalJSON 

func (s *Database) MarshalJSON() ([]byte, error)

type DatabaseFlags 

type DatabaseFlags struct {
	// Name: The name of the flag. These flags are passed at instance startup, so
	// include both server options and system variables. Flags are specified with
	// underscores, not hyphens. For more information, see Configuring Database
	// Flags (https://cloud.google.com/sql/docs/mysql/flags) in the Cloud SQL
	// documentation.
	Name string `json:"name,omitempty"`
	// Value: The value of the flag. Boolean flags are set to `on` for true and
	// `off` for false. This field must be omitted if the flag doesn't take a
	// value.
	Value string `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DatabaseFlags: Database flags for Cloud SQL instances.

func (*DatabaseFlags) MarshalJSON 

func (s *DatabaseFlags) MarshalJSON() ([]byte, error)

type DatabaseInstance 

type DatabaseInstance struct {
	// AvailableMaintenanceVersions: Output only. List all maintenance versions
	// applicable on the instance
	AvailableMaintenanceVersions []string `json:"availableMaintenanceVersions,omitempty"`
	// BackendType: The backend type. `SECOND_GEN`: Cloud SQL database instance.
	// `EXTERNAL`: A database server that is not managed by Google. This property
	// is read-only; use the `tier` property in the `settings` object to determine
	// the database type.
	//
	// Possible values:
	//   "SQL_BACKEND_TYPE_UNSPECIFIED" - This is an unknown backend type for
	// instance.
	//   "FIRST_GEN" - V1 speckle instance.
	//   "SECOND_GEN" - V2 speckle instance.
	//   "EXTERNAL" - On premises instance.
	BackendType string `json:"backendType,omitempty"`
	// ConnectionName: Connection name of the Cloud SQL instance used in connection
	// strings.
	ConnectionName string `json:"connectionName,omitempty"`
	// CreateTime: Output only. The time when the instance was created in RFC 3339
	// (https://tools.ietf.org/html/rfc3339) format, for example
	// `2012-11-15T16:19:00.094Z`.
	CreateTime string `json:"createTime,omitempty"`
	// CurrentDiskSize: The current disk usage of the instance in bytes. This
	// property has been deprecated. Use the
	// "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud
	// Monitoring API instead. Please see this announcement
	// (https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ)
	// for details.
	CurrentDiskSize int64 `json:"currentDiskSize,omitempty,string"`
	// DatabaseInstalledVersion: Output only. Stores the current database version
	// running on the instance including minor version such as `MYSQL_8_0_18`.
	DatabaseInstalledVersion string `json:"databaseInstalledVersion,omitempty"`
	// DatabaseVersion: The database engine type and version. The `databaseVersion`
	// field cannot be changed after instance creation.
	//
	// Possible values:
	//   "SQL_DATABASE_VERSION_UNSPECIFIED" - This is an unknown database version.
	//   "MYSQL_5_1" - The database version is MySQL 5.1.
	//   "MYSQL_5_5" - The database version is MySQL 5.5.
	//   "MYSQL_5_6" - The database version is MySQL 5.6.
	//   "MYSQL_5_7" - The database version is MySQL 5.7.
	//   "SQLSERVER_2017_STANDARD" - The database version is SQL Server 2017
	// Standard.
	//   "SQLSERVER_2017_ENTERPRISE" - The database version is SQL Server 2017
	// Enterprise.
	//   "SQLSERVER_2017_EXPRESS" - The database version is SQL Server 2017
	// Express.
	//   "SQLSERVER_2017_WEB" - The database version is SQL Server 2017 Web.
	//   "POSTGRES_9_6" - The database version is PostgreSQL 9.6.
	//   "POSTGRES_10" - The database version is PostgreSQL 10.
	//   "POSTGRES_11" - The database version is PostgreSQL 11.
	//   "POSTGRES_12" - The database version is PostgreSQL 12.
	//   "POSTGRES_13" - The database version is PostgreSQL 13.
	//   "POSTGRES_14" - The database version is PostgreSQL 14.
	//   "POSTGRES_15" - The database version is PostgreSQL 15.
	//   "POSTGRES_16" - The database version is PostgreSQL 16.
	//   "MYSQL_8_0" - The database version is MySQL 8.
	//   "MYSQL_8_0_18" - The database major version is MySQL 8.0 and the minor
	// version is 18.
	//   "MYSQL_8_0_26" - The database major version is MySQL 8.0 and the minor
	// version is 26.
	//   "MYSQL_8_0_27" - The database major version is MySQL 8.0 and the minor
	// version is 27.
	//   "MYSQL_8_0_28" - The database major version is MySQL 8.0 and the minor
	// version is 28.
	//   "MYSQL_8_0_29" - The database major version is MySQL 8.0 and the minor
	// version is 29.
	//   "MYSQL_8_0_30" - The database major version is MySQL 8.0 and the minor
	// version is 30.
	//   "MYSQL_8_0_31" - The database major version is MySQL 8.0 and the minor
	// version is 31.
	//   "MYSQL_8_0_32" - The database major version is MySQL 8.0 and the minor
	// version is 32.
	//   "MYSQL_8_0_33" - The database major version is MySQL 8.0 and the minor
	// version is 33.
	//   "MYSQL_8_0_34" - The database major version is MySQL 8.0 and the minor
	// version is 34.
	//   "MYSQL_8_0_35" - The database major version is MySQL 8.0 and the minor
	// version is 35.
	//   "MYSQL_8_0_36" - The database major version is MySQL 8.0 and the minor
	// version is 36.
	//   "MYSQL_8_0_37" - The database major version is MySQL 8.0 and the minor
	// version is 37.
	//   "MYSQL_8_0_38" - The database major version is MySQL 8.0 and the minor
	// version is 38.
	//   "MYSQL_8_0_39" - The database major version is MySQL 8.0 and the minor
	// version is 39.
	//   "MYSQL_8_0_40" - The database major version is MySQL 8.0 and the minor
	// version is 40.
	//   "MYSQL_8_4" - The database version is MySQL 8.4.
	//   "MYSQL_8_4_0" - The database version is MySQL 8.4 and the patch version is
	// 0.
	//   "SQLSERVER_2019_STANDARD" - The database version is SQL Server 2019
	// Standard.
	//   "SQLSERVER_2019_ENTERPRISE" - The database version is SQL Server 2019
	// Enterprise.
	//   "SQLSERVER_2019_EXPRESS" - The database version is SQL Server 2019
	// Express.
	//   "SQLSERVER_2019_WEB" - The database version is SQL Server 2019 Web.
	//   "SQLSERVER_2022_STANDARD" - The database version is SQL Server 2022
	// Standard.
	//   "SQLSERVER_2022_ENTERPRISE" - The database version is SQL Server 2022
	// Enterprise.
	//   "SQLSERVER_2022_EXPRESS" - The database version is SQL Server 2022
	// Express.
	//   "SQLSERVER_2022_WEB" - The database version is SQL Server 2022 Web.
	DatabaseVersion string `json:"databaseVersion,omitempty"`
	// DiskEncryptionConfiguration: Disk encryption configuration specific to an
	// instance.
	DiskEncryptionConfiguration *DiskEncryptionConfiguration `json:"diskEncryptionConfiguration,omitempty"`
	// DiskEncryptionStatus: Disk encryption status specific to an instance.
	DiskEncryptionStatus *DiskEncryptionStatus `json:"diskEncryptionStatus,omitempty"`
	// DnsName: Output only. The dns name of the instance.
	DnsName string `json:"dnsName,omitempty"`
	// Etag: This field is deprecated and will be removed from a future version of
	// the API. Use the `settings.settingsVersion` field instead.
	Etag string `json:"etag,omitempty"`
	// FailoverReplica: The name and status of the failover replica.
	FailoverReplica *DatabaseInstanceFailoverReplica `json:"failoverReplica,omitempty"`
	// GceZone: The Compute Engine zone that the instance is currently serving
	// from. This value could be different from the zone that was specified when
	// the instance was created if the instance has failed over to its secondary
	// zone. WARNING: Changing this might restart the instance.
	GceZone string `json:"gceZone,omitempty"`
	// GeminiConfig: Gemini instance configuration.
	GeminiConfig *GeminiInstanceConfig `json:"geminiConfig,omitempty"`
	// InstanceType: The instance type.
	//
	// Possible values:
	//   "SQL_INSTANCE_TYPE_UNSPECIFIED" - This is an unknown Cloud SQL instance
	// type.
	//   "CLOUD_SQL_INSTANCE" - A regular Cloud SQL instance that is not
	// replicating from a primary instance.
	//   "ON_PREMISES_INSTANCE" - An instance running on the customer's premises
	// that is not managed by Cloud SQL.
	//   "READ_REPLICA_INSTANCE" - A Cloud SQL instance acting as a read-replica.
	InstanceType string `json:"instanceType,omitempty"`
	// IpAddresses: The assigned IP addresses for the instance.
	IpAddresses []*IpMapping `json:"ipAddresses,omitempty"`
	// Ipv6Address: The IPv6 address assigned to the instance. (Deprecated) This
	// property was applicable only to First Generation instances.
	Ipv6Address string `json:"ipv6Address,omitempty"`
	// Kind: This is always `sql#instance`.
	Kind string `json:"kind,omitempty"`
	// MaintenanceVersion: The current software version on the instance.
	MaintenanceVersion string `json:"maintenanceVersion,omitempty"`
	// MasterInstanceName: The name of the instance which will act as primary in
	// the replication setup.
	MasterInstanceName string `json:"masterInstanceName,omitempty"`
	// MaxDiskSize: The maximum disk size of the instance in bytes.
	MaxDiskSize int64 `json:"maxDiskSize,omitempty,string"`
	// Name: Name of the Cloud SQL instance. This does not include the project ID.
	Name string `json:"name,omitempty"`
	// OnPremisesConfiguration: Configuration specific to on-premises instances.
	OnPremisesConfiguration *OnPremisesConfiguration `json:"onPremisesConfiguration,omitempty"`
	// OutOfDiskReport: This field represents the report generated by the proactive
	// database wellness job for OutOfDisk issues. * Writers: * the proactive
	// database wellness job for OOD. * Readers: * the proactive database wellness
	// job
	OutOfDiskReport *SqlOutOfDiskReport `json:"outOfDiskReport,omitempty"`
	// PrimaryDnsName: Output only. DEPRECATED: please use write_endpoint instead.
	PrimaryDnsName string `json:"primaryDnsName,omitempty"`
	// Project: The project ID of the project containing the Cloud SQL instance.
	// The Google apps domain is prefixed if applicable.
	Project string `json:"project,omitempty"`
	// PscServiceAttachmentLink: Output only. The link to service attachment of PSC
	// instance.
	PscServiceAttachmentLink string `json:"pscServiceAttachmentLink,omitempty"`
	// Region: The geographical region of the Cloud SQL instance. It can be one of
	// the regions (https://cloud.google.com/sql/docs/mysql/locations#location-r)
	// where Cloud SQL operates: For example, `asia-east1`, `europe-west1`, and
	// `us-central1`. The default value is `us-central1`.
	Region string `json:"region,omitempty"`
	// ReplicaConfiguration: Configuration specific to failover replicas and read
	// replicas.
	ReplicaConfiguration *ReplicaConfiguration `json:"replicaConfiguration,omitempty"`
	// ReplicaNames: The replicas of the instance.
	ReplicaNames []string `json:"replicaNames,omitempty"`
	// ReplicationCluster: A primary instance and disaster recovery (DR) replica
	// pair. A DR replica is a cross-region replica that you designate for failover
	// in the event that the primary instance experiences regional failure. Only
	// applicable to MySQL.
	ReplicationCluster *ReplicationCluster `json:"replicationCluster,omitempty"`
	// RootPassword: Initial root password. Use only on creation. You must set root
	// passwords before you can connect to PostgreSQL instances.
	RootPassword string `json:"rootPassword,omitempty"`
	// SatisfiesPzs: This status indicates whether the instance satisfies PZS. The
	// status is reserved for future use.
	SatisfiesPzs bool `json:"satisfiesPzs,omitempty"`
	// ScheduledMaintenance: The start time of any upcoming scheduled maintenance
	// for this instance.
	ScheduledMaintenance *SqlScheduledMaintenance `json:"scheduledMaintenance,omitempty"`
	// SecondaryGceZone: The Compute Engine zone that the failover instance is
	// currently serving from for a regional instance. This value could be
	// different from the zone that was specified when the instance was created if
	// the instance has failed over to its secondary/failover zone.
	SecondaryGceZone string `json:"secondaryGceZone,omitempty"`
	// SelfLink: The URI of this resource.
	SelfLink string `json:"selfLink,omitempty"`
	// ServerCaCert: SSL configuration.
	ServerCaCert *SslCert `json:"serverCaCert,omitempty"`
	// ServiceAccountEmailAddress: The service account email address assigned to
	// the instance. \This property is read-only.
	ServiceAccountEmailAddress string `json:"serviceAccountEmailAddress,omitempty"`
	// Settings: The user settings.
	Settings *Settings `json:"settings,omitempty"`
	// SqlNetworkArchitecture: The SQL network architecture for the instance.
	//
	// Possible values:
	//   "SQL_NETWORK_ARCHITECTURE_UNSPECIFIED"
	//   "NEW_NETWORK_ARCHITECTURE" - The instance uses the new network
	// architecture.
	//   "OLD_NETWORK_ARCHITECTURE" - The instance uses the old network
	// architecture.
	SqlNetworkArchitecture string `json:"sqlNetworkArchitecture,omitempty"`
	// State: The current serving state of the Cloud SQL instance.
	//
	// Possible values:
	//   "SQL_INSTANCE_STATE_UNSPECIFIED" - The state of the instance is unknown.
	//   "RUNNABLE" - The instance is running, or has been stopped by owner.
	//   "SUSPENDED" - The instance is not available, for example due to problems
	// with billing.
	//   "PENDING_DELETE" - The instance is being deleted.
	//   "PENDING_CREATE" - The instance is being created.
	//   "MAINTENANCE" - The instance is down for maintenance.
	//   "FAILED" - The creation of the instance failed or a fatal error occurred
	// during maintenance.
	//   "ONLINE_MAINTENANCE" - Deprecated
	State string `json:"state,omitempty"`
	// SuspensionReason: If the instance state is SUSPENDED, the reason for the
	// suspension.
	//
	// Possible values:
	//   "SQL_SUSPENSION_REASON_UNSPECIFIED" - This is an unknown suspension
	// reason.
	//   "BILLING_ISSUE" - The instance is suspended due to billing issues (for
	// example:, GCP account issue)
	//   "LEGAL_ISSUE" - The instance is suspended due to illegal content (for
	// example:, child pornography, copyrighted material, etc.).
	//   "OPERATIONAL_ISSUE" - The instance is causing operational issues (for
	// example:, causing the database to crash).
	//   "KMS_KEY_ISSUE" - The KMS key used by the instance is either revoked or
	// denied access to
	SuspensionReason []string `json:"suspensionReason,omitempty"`
	// UpgradableDatabaseVersions: Output only. All database versions that are
	// available for upgrade.
	UpgradableDatabaseVersions []*AvailableDatabaseVersion `json:"upgradableDatabaseVersions,omitempty"`
	// WriteEndpoint: Output only. The dns name of the primary instance in a
	// replication group.
	WriteEndpoint string `json:"writeEndpoint,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g.
	// "AvailableMaintenanceVersions") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
	// for more details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AvailableMaintenanceVersions") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DatabaseInstance: A Cloud SQL instance resource.

func (*DatabaseInstance) MarshalJSON 

func (s *DatabaseInstance) MarshalJSON() ([]byte, error)

type DatabaseInstanceFailoverReplica 

type DatabaseInstanceFailoverReplica struct {
	// Available: The availability status of the failover replica. A false status
	// indicates that the failover replica is out of sync. The primary instance can
	// only failover to the failover replica when the status is true.
	Available bool `json:"available,omitempty"`
	// Name: The name of the failover replica. If specified at instance creation, a
	// failover replica is created for the instance. The name doesn't include the
	// project ID.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Available") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Available") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DatabaseInstanceFailoverReplica: The name and status of the failover replica.

func (*DatabaseInstanceFailoverReplica) MarshalJSON 

func (s *DatabaseInstanceFailoverReplica) MarshalJSON() ([]byte, error)

type DatabasesDeleteCall 

type DatabasesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*DatabasesDeleteCall) Context 

func (c *DatabasesDeleteCall) Context(ctx context.Context) *DatabasesDeleteCall

Context sets the context to be used in this call's Do method.

func (*DatabasesDeleteCall) Do 

func (c *DatabasesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.databases.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatabasesDeleteCall) Fields 

func (c *DatabasesDeleteCall) Fields(s ...googleapi.Field) *DatabasesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*DatabasesDeleteCall) Header 

func (c *DatabasesDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type DatabasesGetCall 

type DatabasesGetCall struct {
	// contains filtered or unexported fields
}

func (*DatabasesGetCall) Context 

func (c *DatabasesGetCall) Context(ctx context.Context) *DatabasesGetCall

Context sets the context to be used in this call's Do method.

func (*DatabasesGetCall) Do 

func (c *DatabasesGetCall) Do(opts ...googleapi.CallOption) (*Database, error)

Do executes the "sql.databases.get" call. Any non-2xx status code is an error. Response headers are in either *Database.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatabasesGetCall) Fields 

func (c *DatabasesGetCall) Fields(s ...googleapi.Field) *DatabasesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*DatabasesGetCall) Header 

func (c *DatabasesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*DatabasesGetCall) IfNoneMatch 

func (c *DatabasesGetCall) IfNoneMatch(entityTag string) *DatabasesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type DatabasesInsertCall 

type DatabasesInsertCall struct {
	// contains filtered or unexported fields
}

func (*DatabasesInsertCall) Context 

func (c *DatabasesInsertCall) Context(ctx context.Context) *DatabasesInsertCall

Context sets the context to be used in this call's Do method.

func (*DatabasesInsertCall) Do 

func (c *DatabasesInsertCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.databases.insert" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatabasesInsertCall) Fields 

func (c *DatabasesInsertCall) Fields(s ...googleapi.Field) *DatabasesInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*DatabasesInsertCall) Header 

func (c *DatabasesInsertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type DatabasesListCall 

type DatabasesListCall struct {
	// contains filtered or unexported fields
}

func (*DatabasesListCall) Context 

func (c *DatabasesListCall) Context(ctx context.Context) *DatabasesListCall

Context sets the context to be used in this call's Do method.

func (*DatabasesListCall) Do 

func (c *DatabasesListCall) Do(opts ...googleapi.CallOption) (*DatabasesListResponse, error)

Do executes the "sql.databases.list" call. Any non-2xx status code is an error. Response headers are in either *DatabasesListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatabasesListCall) Fields 

func (c *DatabasesListCall) Fields(s ...googleapi.Field) *DatabasesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*DatabasesListCall) Header 

func (c *DatabasesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*DatabasesListCall) IfNoneMatch 

func (c *DatabasesListCall) IfNoneMatch(entityTag string) *DatabasesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type DatabasesListResponse 

type DatabasesListResponse struct {
	// Items: List of database resources in the instance.
	Items []*Database `json:"items,omitempty"`
	// Kind: This is always `sql#databasesList`.
	Kind string `json:"kind,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Items") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DatabasesListResponse: Database list response.

func (*DatabasesListResponse) MarshalJSON 

func (s *DatabasesListResponse) MarshalJSON() ([]byte, error)

type DatabasesPatchCall 

type DatabasesPatchCall struct {
	// contains filtered or unexported fields
}

func (*DatabasesPatchCall) Context 

func (c *DatabasesPatchCall) Context(ctx context.Context) *DatabasesPatchCall

Context sets the context to be used in this call's Do method.

func (*DatabasesPatchCall) Do 

func (c *DatabasesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.databases.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatabasesPatchCall) Fields 

func (c *DatabasesPatchCall) Fields(s ...googleapi.Field) *DatabasesPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*DatabasesPatchCall) Header 

func (c *DatabasesPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type DatabasesService 

type DatabasesService struct {
	// contains filtered or unexported fields
}

func NewDatabasesService 

func NewDatabasesService(s *Service) *DatabasesService

func (*DatabasesService) Delete 

func (r *DatabasesService) Delete(project string, instance string, database string) *DatabasesDeleteCall

Delete: Deletes a database from a Cloud SQL instance.

- database: Name of the database to be deleted in the instance. - instance: Database instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*DatabasesService) Get 

func (r *DatabasesService) Get(project string, instance string, database string) *DatabasesGetCall

Get: Retrieves a resource containing information about a database inside a Cloud SQL instance.

- database: Name of the database in the instance. - instance: Database instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*DatabasesService) Insert 

func (r *DatabasesService) Insert(project string, instance string, database *Database) *DatabasesInsertCall

Insert: Inserts a resource containing information about a database inside a Cloud SQL instance. **Note:** You can't modify the default character set and collation.

- instance: Database instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*DatabasesService) List 

func (r *DatabasesService) List(project string, instance string) *DatabasesListCall

List: Lists databases in the specified Cloud SQL instance.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*DatabasesService) Patch 

func (r *DatabasesService) Patch(project string, instance string, database string, database2 *Database) *DatabasesPatchCall

Patch: Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.

- database: Name of the database to be updated in the instance. - instance: Database instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*DatabasesService) Update 

func (r *DatabasesService) Update(project string, instance string, database string, database2 *Database) *DatabasesUpdateCall

Update: Updates a resource containing information about a database inside a Cloud SQL instance.

- database: Name of the database to be updated in the instance. - instance: Database instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

type DatabasesUpdateCall 

type DatabasesUpdateCall struct {
	// contains filtered or unexported fields
}

func (*DatabasesUpdateCall) Context 

func (c *DatabasesUpdateCall) Context(ctx context.Context) *DatabasesUpdateCall

Context sets the context to be used in this call's Do method.

func (*DatabasesUpdateCall) Do 

func (c *DatabasesUpdateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.databases.update" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatabasesUpdateCall) Fields 

func (c *DatabasesUpdateCall) Fields(s ...googleapi.Field) *DatabasesUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*DatabasesUpdateCall) Header 

func (c *DatabasesUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type DemoteContext added in v0.151.0 

type DemoteContext struct {
	// Kind: This is always `sql#demoteContext`.
	Kind string `json:"kind,omitempty"`
	// SourceRepresentativeInstanceName: Required. The name of the instance which
	// acts as an on-premises primary instance in the replication setup.
	SourceRepresentativeInstanceName string `json:"sourceRepresentativeInstanceName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Kind") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DemoteContext: This context is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.

func (*DemoteContext) MarshalJSON added in v0.151.0 

func (s *DemoteContext) MarshalJSON() ([]byte, error)

type DemoteMasterConfiguration 

type DemoteMasterConfiguration struct {
	// Kind: This is always `sql#demoteMasterConfiguration`.
	Kind string `json:"kind,omitempty"`
	// MysqlReplicaConfiguration: MySQL specific configuration when replicating
	// from a MySQL on-premises primary instance. 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.
	MysqlReplicaConfiguration *DemoteMasterMySqlReplicaConfiguration `json:"mysqlReplicaConfiguration,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Kind") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DemoteMasterConfiguration: Read-replica configuration for connecting to the on-premises primary instance.

func (*DemoteMasterConfiguration) MarshalJSON 

func (s *DemoteMasterConfiguration) MarshalJSON() ([]byte, error)

type DemoteMasterContext 

type DemoteMasterContext struct {
	// Kind: This is always `sql#demoteMasterContext`.
	Kind string `json:"kind,omitempty"`
	// MasterInstanceName: The name of the instance which will act as on-premises
	// primary instance in the replication setup.
	MasterInstanceName string `json:"masterInstanceName,omitempty"`
	// ReplicaConfiguration: Configuration specific to read-replicas replicating
	// from the on-premises primary instance.
	ReplicaConfiguration *DemoteMasterConfiguration `json:"replicaConfiguration,omitempty"`
	// SkipReplicationSetup: Flag to skip replication setup on the instance.
	SkipReplicationSetup bool `json:"skipReplicationSetup,omitempty"`
	// VerifyGtidConsistency: Verify the GTID consistency for demote operation.
	// Default value: `True`. Setting this flag to `false` enables you to bypass
	// the GTID consistency check between on-premises primary instance and Cloud
	// SQL instance during the demotion operation but also exposes you to the risk
	// of future replication failures. Change the value only if you know the reason
	// for the GTID divergence and are confident that doing so will not cause any
	// replication issues.
	VerifyGtidConsistency bool `json:"verifyGtidConsistency,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Kind") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DemoteMasterContext: Database instance demote primary instance context.

func (*DemoteMasterContext) MarshalJSON 

func (s *DemoteMasterContext) MarshalJSON() ([]byte, error)

type DemoteMasterMySqlReplicaConfiguration 

type DemoteMasterMySqlReplicaConfiguration struct {
	// CaCertificate: PEM representation of the trusted CA's x509 certificate.
	CaCertificate string `json:"caCertificate,omitempty"`
	// ClientCertificate: PEM representation of the replica's x509 certificate.
	ClientCertificate string `json:"clientCertificate,omitempty"`
	// ClientKey: PEM representation of the replica's private key. The
	// corresponsing public key is encoded in the client's certificate. The format
	// of the replica's private key can be either PKCS #1 or PKCS #8.
	ClientKey string `json:"clientKey,omitempty"`
	// Kind: This is always `sql#demoteMasterMysqlReplicaConfiguration`.
	Kind string `json:"kind,omitempty"`
	// Password: The password for the replication connection.
	Password string `json:"password,omitempty"`
	// Username: The username for the replication connection.
	Username string `json:"username,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CaCertificate") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CaCertificate") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DemoteMasterMySqlReplicaConfiguration: Read-replica configuration specific to MySQL databases.

func (*DemoteMasterMySqlReplicaConfiguration) MarshalJSON 

func (s *DemoteMasterMySqlReplicaConfiguration) MarshalJSON() ([]byte, error)

type DenyMaintenancePeriod added in v0.33.0 

type DenyMaintenancePeriod struct {
	// EndDate: "deny maintenance period" end date. If the year of the end date is
	// empty, the year of the start date also must be empty. In this case, it means
	// the deny maintenance period recurs every year. The date is in format
	// yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
	EndDate string `json:"endDate,omitempty"`
	// StartDate: "deny maintenance period" start date. If the year of the start
	// date is empty, the year of the end date also must be empty. In this case, it
	// means the deny maintenance period recurs every year. The date is in format
	// yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
	StartDate string `json:"startDate,omitempty"`
	// Time: Time in UTC when the "deny maintenance period" starts on start_date
	// and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
	Time string `json:"time,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndDate") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndDate") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DenyMaintenancePeriod: Deny Maintenance Periods. This specifies a date range during when all CSA rollout will be denied.

func (*DenyMaintenancePeriod) MarshalJSON added in v0.33.0 

func (s *DenyMaintenancePeriod) MarshalJSON() ([]byte, error)

type DiskEncryptionConfiguration added in v0.3.1 

type DiskEncryptionConfiguration struct {
	// Kind: This is always `sql#diskEncryptionConfiguration`.
	Kind string `json:"kind,omitempty"`
	// KmsKeyName: Resource name of KMS key for disk encryption
	KmsKeyName string `json:"kmsKeyName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Kind") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DiskEncryptionConfiguration: Disk encryption configuration for an instance.

func (*DiskEncryptionConfiguration) MarshalJSON added in v0.3.1 

func (s *DiskEncryptionConfiguration) MarshalJSON() ([]byte, error)

type DiskEncryptionStatus added in v0.3.1 

type DiskEncryptionStatus struct {
	// Kind: This is always `sql#diskEncryptionStatus`.
	Kind string `json:"kind,omitempty"`
	// KmsKeyVersionName: KMS key version used to encrypt the Cloud SQL instance
	// resource
	KmsKeyVersionName string `json:"kmsKeyVersionName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Kind") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DiskEncryptionStatus: Disk encryption status for an instance.

func (*DiskEncryptionStatus) MarshalJSON added in v0.3.1 

func (s *DiskEncryptionStatus) MarshalJSON() ([]byte, error)

type Empty added in v0.126.0 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type ExportContext 

type ExportContext struct {
	// BakExportOptions: Options for exporting BAK files (SQL Server-only)
	BakExportOptions *ExportContextBakExportOptions `json:"bakExportOptions,omitempty"`
	// CsvExportOptions: Options for exporting data as CSV. `MySQL` and
	// `PostgreSQL` instances only.
	CsvExportOptions *ExportContextCsvExportOptions `json:"csvExportOptions,omitempty"`
	// Databases: 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`.
	Databases []string `json:"databases,omitempty"`
	// FileType: The file type for the specified uri.
	//
	// Possible values:
	//   "SQL_FILE_TYPE_UNSPECIFIED" - Unknown file type.
	//   "SQL" - File containing SQL statements.
	//   "CSV" - File in CSV format.
	//   "BAK"
	FileType string `json:"fileType,omitempty"`
	// Kind: This is always `sql#exportContext`.
	Kind string `json:"kind,omitempty"`
	// Offload: Option for export offload.
	Offload bool `json:"offload,omitempty"`
	// SqlExportOptions: Options for exporting data as SQL statements.
	SqlExportOptions *ExportContextSqlExportOptions `json:"sqlExportOptions,omitempty"`
	// Uri: 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.
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BakExportOptions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BakExportOptions") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportContext: Database instance export context.

func (*ExportContext) MarshalJSON 

func (s *ExportContext) MarshalJSON() ([]byte, error)

type ExportContextBakExportOptions added in v0.101.0 

type ExportContextBakExportOptions struct {
	// BakType: Type of this bak file will be export, FULL or DIFF, SQL Server only
	//
	// Possible values:
	//   "BAK_TYPE_UNSPECIFIED" - Default type.
	//   "FULL" - Full backup.
	//   "DIFF" - Differential backup.
	//   "TLOG" - SQL Server Transaction Log
	BakType string `json:"bakType,omitempty"`
	// CopyOnly: Deprecated: copy_only is deprecated. Use differential_base instead
	CopyOnly bool `json:"copyOnly,omitempty"`
	// DifferentialBase: Whether or not the backup can be used as a differential
	// base copy_only backup can not be served as differential base
	DifferentialBase bool `json:"differentialBase,omitempty"`
	// StripeCount: 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.
	StripeCount int64 `json:"stripeCount,omitempty"`
	// Striped: Whether or not the export should be striped.
	Striped bool `json:"striped,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BakType") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BakType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportContextBakExportOptions: Options for exporting BAK files (SQL Server-only)

func (*ExportContextBakExportOptions) MarshalJSON added in v0.101.0 

func (s *ExportContextBakExportOptions) MarshalJSON() ([]byte, error)

type ExportContextCsvExportOptions 

type ExportContextCsvExportOptions struct {
	// EscapeCharacter: Specifies the character that should appear before a data
	// character that needs to be escaped.
	EscapeCharacter string `json:"escapeCharacter,omitempty"`
	// FieldsTerminatedBy: Specifies the character that separates columns within
	// each row (line) of the file.
	FieldsTerminatedBy string `json:"fieldsTerminatedBy,omitempty"`
	// LinesTerminatedBy: 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.
	LinesTerminatedBy string `json:"linesTerminatedBy,omitempty"`
	// QuoteCharacter: Specifies the quoting character to be used when a data value
	// is quoted.
	QuoteCharacter string `json:"quoteCharacter,omitempty"`
	// SelectQuery: The select query used to extract the data.
	SelectQuery string `json:"selectQuery,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EscapeCharacter") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EscapeCharacter") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportContextCsvExportOptions: Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.

func (*ExportContextCsvExportOptions) MarshalJSON 

func (s *ExportContextCsvExportOptions) MarshalJSON() ([]byte, error)

type ExportContextSqlExportOptions 

type ExportContextSqlExportOptions struct {
	// MysqlExportOptions: Options for exporting from MySQL.
	MysqlExportOptions *ExportContextSqlExportOptionsMysqlExportOptions `json:"mysqlExportOptions,omitempty"`
	// Parallel: Optional. Whether or not the export should be parallel.
	Parallel bool `json:"parallel,omitempty"`
	// SchemaOnly: Export only schemas.
	SchemaOnly bool `json:"schemaOnly,omitempty"`
	// Tables: 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.
	Tables []string `json:"tables,omitempty"`
	// Threads: Optional. The number of threads to use for parallel export.
	Threads int64 `json:"threads,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MysqlExportOptions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MysqlExportOptions") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportContextSqlExportOptions: Options for exporting data as SQL statements.

func (*ExportContextSqlExportOptions) MarshalJSON 

func (s *ExportContextSqlExportOptions) MarshalJSON() ([]byte, error)

type ExportContextSqlExportOptionsMysqlExportOptions 

type ExportContextSqlExportOptionsMysqlExportOptions struct {
	// MasterData: 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.
	MasterData int64 `json:"masterData,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MasterData") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MasterData") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExportContextSqlExportOptionsMysqlExportOptions: Options for exporting from MySQL.

func (*ExportContextSqlExportOptionsMysqlExportOptions) MarshalJSON 

func (s *ExportContextSqlExportOptionsMysqlExportOptions) MarshalJSON() ([]byte, error)

type FailoverContext 

type FailoverContext struct {
	// Kind: This is always `sql#failoverContext`.
	Kind string `json:"kind,omitempty"`
	// SettingsVersion: The current settings version of this instance. Request will
	// be rejected if this version doesn't match the current settings version.
	SettingsVersion int64 `json:"settingsVersion,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Kind") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FailoverContext: Database instance failover context.

func (*FailoverContext) MarshalJSON 

func (s *FailoverContext) MarshalJSON() ([]byte, error)

type Flag 

type Flag struct {
	// AllowedIntValues: Use this field if only certain integers are accepted. Can
	// be combined with min_value and max_value to add additional values.
	AllowedIntValues googleapi.Int64s `json:"allowedIntValues,omitempty"`
	// AllowedStringValues: For `STRING` flags, a list of strings that the value
	// can be set to.
	AllowedStringValues []string `json:"allowedStringValues,omitempty"`
	// AppliesTo: The database version this flag applies to. Can be MySQL
	// instances: `MYSQL_8_0`, `MYSQL_8_0_18`, `MYSQL_8_0_26`, `MYSQL_5_7`, or
	// `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`,
	// `POSTGRES_11` or `POSTGRES_12`. SQL Server instances:
	// `SQLSERVER_2017_STANDARD`, `SQLSERVER_2017_ENTERPRISE`,
	// `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`,
	// `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or
	// `SQLSERVER_2019_WEB`. See the complete list
	// (/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).
	//
	// Possible values:
	//   "SQL_DATABASE_VERSION_UNSPECIFIED" - This is an unknown database version.
	//   "MYSQL_5_1" - The database version is MySQL 5.1.
	//   "MYSQL_5_5" - The database version is MySQL 5.5.
	//   "MYSQL_5_6" - The database version is MySQL 5.6.
	//   "MYSQL_5_7" - The database version is MySQL 5.7.
	//   "SQLSERVER_2017_STANDARD" - The database version is SQL Server 2017
	// Standard.
	//   "SQLSERVER_2017_ENTERPRISE" - The database version is SQL Server 2017
	// Enterprise.
	//   "SQLSERVER_2017_EXPRESS" - The database version is SQL Server 2017
	// Express.
	//   "SQLSERVER_2017_WEB" - The database version is SQL Server 2017 Web.
	//   "POSTGRES_9_6" - The database version is PostgreSQL 9.6.
	//   "POSTGRES_10" - The database version is PostgreSQL 10.
	//   "POSTGRES_11" - The database version is PostgreSQL 11.
	//   "POSTGRES_12" - The database version is PostgreSQL 12.
	//   "POSTGRES_13" - The database version is PostgreSQL 13.
	//   "POSTGRES_14" - The database version is PostgreSQL 14.
	//   "POSTGRES_15" - The database version is PostgreSQL 15.
	//   "POSTGRES_16" - The database version is PostgreSQL 16.
	//   "MYSQL_8_0" - The database version is MySQL 8.
	//   "MYSQL_8_0_18" - The database major version is MySQL 8.0 and the minor
	// version is 18.
	//   "MYSQL_8_0_26" - The database major version is MySQL 8.0 and the minor
	// version is 26.
	//   "MYSQL_8_0_27" - The database major version is MySQL 8.0 and the minor
	// version is 27.
	//   "MYSQL_8_0_28" - The database major version is MySQL 8.0 and the minor
	// version is 28.
	//   "MYSQL_8_0_29" - The database major version is MySQL 8.0 and the minor
	// version is 29.
	//   "MYSQL_8_0_30" - The database major version is MySQL 8.0 and the minor
	// version is 30.
	//   "MYSQL_8_0_31" - The database major version is MySQL 8.0 and the minor
	// version is 31.
	//   "MYSQL_8_0_32" - The database major version is MySQL 8.0 and the minor
	// version is 32.
	//   "MYSQL_8_0_33" - The database major version is MySQL 8.0 and the minor
	// version is 33.
	//   "MYSQL_8_0_34" - The database major version is MySQL 8.0 and the minor
	// version is 34.
	//   "MYSQL_8_0_35" - The database major version is MySQL 8.0 and the minor
	// version is 35.
	//   "MYSQL_8_0_36" - The database major version is MySQL 8.0 and the minor
	// version is 36.
	//   "MYSQL_8_0_37" - The database major version is MySQL 8.0 and the minor
	// version is 37.
	//   "MYSQL_8_0_38" - The database major version is MySQL 8.0 and the minor
	// version is 38.
	//   "MYSQL_8_0_39" - The database major version is MySQL 8.0 and the minor
	// version is 39.
	//   "MYSQL_8_0_40" - The database major version is MySQL 8.0 and the minor
	// version is 40.
	//   "MYSQL_8_4" - The database version is MySQL 8.4.
	//   "MYSQL_8_4_0" - The database version is MySQL 8.4 and the patch version is
	// 0.
	//   "SQLSERVER_2019_STANDARD" - The database version is SQL Server 2019
	// Standard.
	//   "SQLSERVER_2019_ENTERPRISE" - The database version is SQL Server 2019
	// Enterprise.
	//   "SQLSERVER_2019_EXPRESS" - The database version is SQL Server 2019
	// Express.
	//   "SQLSERVER_2019_WEB" - The database version is SQL Server 2019 Web.
	//   "SQLSERVER_2022_STANDARD" - The database version is SQL Server 2022
	// Standard.
	//   "SQLSERVER_2022_ENTERPRISE" - The database version is SQL Server 2022
	// Enterprise.
	//   "SQLSERVER_2022_EXPRESS" - The database version is SQL Server 2022
	// Express.
	//   "SQLSERVER_2022_WEB" - The database version is SQL Server 2022 Web.
	AppliesTo []string `json:"appliesTo,omitempty"`
	// InBeta: Whether or not the flag is considered in beta.
	InBeta bool `json:"inBeta,omitempty"`
	// Kind: This is always `sql#flag`.
	Kind string `json:"kind,omitempty"`
	// MaxValue: For `INTEGER` flags, the maximum allowed value.
	MaxValue int64 `json:"maxValue,omitempty,string"`
	// MinValue: For `INTEGER` flags, the minimum allowed value.
	MinValue int64 `json:"minValue,omitempty,string"`
	// Name: This is the name of the flag. Flag names always use underscores, not
	// hyphens, for example: `max_allowed_packet`
	Name string `json:"name,omitempty"`
	// RequiresRestart: Indicates whether changing this flag will trigger a
	// database restart. Only applicable to Second Generation instances.
	RequiresRestart bool `json:"requiresRestart,omitempty"`
	// Type: 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`.
	//
	// Possible values:
	//   "SQL_FLAG_TYPE_UNSPECIFIED" - This is an unknown flag type.
	//   "BOOLEAN" - Boolean type flag.
	//   "STRING" - String type flag.
	//   "INTEGER" - Integer type flag.
	//   "NONE" - Flag type used for a server startup option.
	//   "MYSQL_TIMEZONE_OFFSET" - Type introduced specially for MySQL TimeZone
	// offset. Accept a string value with the format [-12:59, 13:00].
	//   "FLOAT" - Float type flag.
	//   "REPEATED_STRING" - Comma-separated list of the strings in a SqlFlagType
	// enum.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedIntValues") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowedIntValues") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Flag: A flag resource.

func (*Flag) MarshalJSON 

func (s *Flag) MarshalJSON() ([]byte, error)

type FlagsListCall 

type FlagsListCall struct {
	// contains filtered or unexported fields
}

func (*FlagsListCall) Context 

func (c *FlagsListCall) Context(ctx context.Context) *FlagsListCall

Context sets the context to be used in this call's Do method.

func (*FlagsListCall) DatabaseVersion 

func (c *FlagsListCall) DatabaseVersion(databaseVersion string) *FlagsListCall

DatabaseVersion sets the optional parameter "databaseVersion": Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.

func (*FlagsListCall) Do 

func (c *FlagsListCall) Do(opts ...googleapi.CallOption) (*FlagsListResponse, error)

Do executes the "sql.flags.list" call. Any non-2xx status code is an error. Response headers are in either *FlagsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FlagsListCall) Fields 

func (c *FlagsListCall) Fields(s ...googleapi.Field) *FlagsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FlagsListCall) Header 

func (c *FlagsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*FlagsListCall) IfNoneMatch 

func (c *FlagsListCall) IfNoneMatch(entityTag string) *FlagsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type FlagsListResponse 

type FlagsListResponse struct {
	// Items: List of flags.
	Items []*Flag `json:"items,omitempty"`
	// Kind: This is always `sql#flagsList`.
	Kind string `json:"kind,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Items") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

FlagsListResponse: Flags list response.

func (*FlagsListResponse) MarshalJSON 

func (s *FlagsListResponse) MarshalJSON() ([]byte, error)

type FlagsService 

type FlagsService struct {
	// contains filtered or unexported fields
}

func NewFlagsService 

func NewFlagsService(s *Service) *FlagsService

func (*FlagsService) List 

func (r *FlagsService) List() *FlagsListCall

List: Lists all available database flags for Cloud SQL instances.

type GeminiInstanceConfig added in v0.172.0 

type GeminiInstanceConfig struct {
	// ActiveQueryEnabled: Output only. Whether the active query is enabled.
	ActiveQueryEnabled bool `json:"activeQueryEnabled,omitempty"`
	// Entitled: Output only. Whether Gemini is enabled.
	Entitled bool `json:"entitled,omitempty"`
	// FlagRecommenderEnabled: Output only. Whether the flag recommender is
	// enabled.
	FlagRecommenderEnabled bool `json:"flagRecommenderEnabled,omitempty"`
	// GoogleVacuumMgmtEnabled: Output only. Whether the vacuum management is
	// enabled.
	GoogleVacuumMgmtEnabled bool `json:"googleVacuumMgmtEnabled,omitempty"`
	// IndexAdvisorEnabled: Output only. Whether the index advisor is enabled.
	IndexAdvisorEnabled bool `json:"indexAdvisorEnabled,omitempty"`
	// OomSessionCancelEnabled: Output only. Whether canceling the out-of-memory
	// (OOM) session is enabled.
	OomSessionCancelEnabled bool `json:"oomSessionCancelEnabled,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ActiveQueryEnabled") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ActiveQueryEnabled") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GeminiInstanceConfig: Gemini instance configuration.

func (*GeminiInstanceConfig) MarshalJSON added in v0.172.0 

func (s *GeminiInstanceConfig) MarshalJSON() ([]byte, error)

type GenerateEphemeralCertRequest added in v0.51.0 

type GenerateEphemeralCertRequest struct {
	// AccessToken: Optional. Access token to include in the signed certificate.
	AccessToken string `json:"access_token,omitempty"`
	// PublicKey: PEM encoded public key to include in the signed certificate.
	PublicKey string `json:"public_key,omitempty"`
	// ReadTime: Optional. Optional snapshot read timestamp to trade freshness for
	// performance.
	ReadTime string `json:"readTime,omitempty"`
	// ValidDuration: Optional. If set, it will contain the cert valid duration.
	ValidDuration string `json:"validDuration,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AccessToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AccessToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateEphemeralCertRequest: Ephemeral certificate creation request.

func (*GenerateEphemeralCertRequest) MarshalJSON added in v0.51.0 

func (s *GenerateEphemeralCertRequest) MarshalJSON() ([]byte, error)

type GenerateEphemeralCertResponse added in v0.51.0 

type GenerateEphemeralCertResponse struct {
	// EphemeralCert: Generated cert
	EphemeralCert *SslCert `json:"ephemeralCert,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "EphemeralCert") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EphemeralCert") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateEphemeralCertResponse: Ephemeral certificate creation request.

func (*GenerateEphemeralCertResponse) MarshalJSON added in v0.51.0 

func (s *GenerateEphemeralCertResponse) MarshalJSON() ([]byte, error)

type ImportContext 

type ImportContext struct {
	// BakImportOptions: Import parameters specific to SQL Server .BAK files
	BakImportOptions *ImportContextBakImportOptions `json:"bakImportOptions,omitempty"`
	// CsvImportOptions: Options for importing data as CSV.
	CsvImportOptions *ImportContextCsvImportOptions `json:"csvImportOptions,omitempty"`
	// Database: 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.
	Database string `json:"database,omitempty"`
	// FileType: The file type for the specified uri. * `SQL`: The file contains
	// SQL statements. * `CSV`: The file contains CSV data. * `BAK`: The file
	// contains backup data for a SQL Server instance.
	//
	// Possible values:
	//   "SQL_FILE_TYPE_UNSPECIFIED" - Unknown file type.
	//   "SQL" - File containing SQL statements.
	//   "CSV" - File in CSV format.
	//   "BAK"
	FileType string `json:"fileType,omitempty"`
	// ImportUser: The PostgreSQL user for this import operation. PostgreSQL
	// instances only.
	ImportUser string `json:"importUser,omitempty"`
	// Kind: This is always `sql#importContext`.
	Kind string `json:"kind,omitempty"`
	// SqlImportOptions: Optional. Options for importing data from SQL statements.
	SqlImportOptions *ImportContextSqlImportOptions `json:"sqlImportOptions,omitempty"`
	// Uri: 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.
	Uri string `json:"uri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BakImportOptions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BakImportOptions") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportContext: Database instance import context.

func (*ImportContext) MarshalJSON 

func (s *ImportContext) MarshalJSON() ([]byte, error)

type ImportContextBakImportOptions added in v0.10.0 

type ImportContextBakImportOptions struct {
	// BakType: Type of the bak content, FULL or DIFF.
	//
	// Possible values:
	//   "BAK_TYPE_UNSPECIFIED" - Default type.
	//   "FULL" - Full backup.
	//   "DIFF" - Differential backup.
	//   "TLOG" - SQL Server Transaction Log
	BakType           string                                          `json:"bakType,omitempty"`
	EncryptionOptions *ImportContextBakImportOptionsEncryptionOptions `json:"encryptionOptions,omitempty"`
	// NoRecovery: Whether or not the backup importing will restore database with
	// NORECOVERY option Applies only to Cloud SQL for SQL Server.
	NoRecovery bool `json:"noRecovery,omitempty"`
	// RecoveryOnly: Whether or not the backup importing request will just bring
	// database online without downloading Bak content only one of "no_recovery"
	// and "recovery_only" can be true otherwise error will return. Applies only to
	// Cloud SQL for SQL Server.
	RecoveryOnly bool `json:"recoveryOnly,omitempty"`
	// StopAt: 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.
	StopAt string `json:"stopAt,omitempty"`
	// StopAtMark: 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.
	StopAtMark string `json:"stopAtMark,omitempty"`
	// Striped: Whether or not the backup set being restored is striped. Applies
	// only to Cloud SQL for SQL Server.
	Striped bool `json:"striped,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BakType") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BakType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportContextBakImportOptions: Import parameters specific to SQL Server .BAK files

func (*ImportContextBakImportOptions) MarshalJSON added in v0.10.0 

func (s *ImportContextBakImportOptions) MarshalJSON() ([]byte, error)

type ImportContextBakImportOptionsEncryptionOptions added in v0.10.0 

type ImportContextBakImportOptionsEncryptionOptions struct {
	// CertPath: 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.
	CertPath string `json:"certPath,omitempty"`
	// PvkPassword: Password that encrypts the private key
	PvkPassword string `json:"pvkPassword,omitempty"`
	// PvkPath: 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.
	PvkPath string `json:"pvkPath,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CertPath") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CertPath") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*ImportContextBakImportOptionsEncryptionOptions) MarshalJSON added in v0.10.0 

func (s *ImportContextBakImportOptionsEncryptionOptions) MarshalJSON() ([]byte, error)

type ImportContextCsvImportOptions 

type ImportContextCsvImportOptions struct {
	// Columns: The columns to which CSV data is imported. If not specified, all
	// columns of the database table are loaded with CSV data.
	Columns []string `json:"columns,omitempty"`
	// EscapeCharacter: Specifies the character that should appear before a data
	// character that needs to be escaped.
	EscapeCharacter string `json:"escapeCharacter,omitempty"`
	// FieldsTerminatedBy: Specifies the character that separates columns within
	// each row (line) of the file.
	FieldsTerminatedBy string `json:"fieldsTerminatedBy,omitempty"`
	// LinesTerminatedBy: 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.
	LinesTerminatedBy string `json:"linesTerminatedBy,omitempty"`
	// QuoteCharacter: Specifies the quoting character to be used when a data value
	// is quoted.
	QuoteCharacter string `json:"quoteCharacter,omitempty"`
	// Table: The table to which CSV data is imported.
	Table string `json:"table,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Columns") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Columns") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportContextCsvImportOptions: Options for importing data as CSV.

func (*ImportContextCsvImportOptions) MarshalJSON 

func (s *ImportContextCsvImportOptions) MarshalJSON() ([]byte, error)

type ImportContextSqlImportOptions added in v0.173.0 

type ImportContextSqlImportOptions struct {
	// Parallel: Optional. Whether or not the import should be parallel.
	Parallel bool `json:"parallel,omitempty"`
	// Threads: Optional. The number of threads to use for parallel import.
	Threads int64 `json:"threads,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Parallel") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Parallel") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ImportContextSqlImportOptions: Optional. Options for importing data from SQL statements.

func (*ImportContextSqlImportOptions) MarshalJSON added in v0.173.0 

func (s *ImportContextSqlImportOptions) MarshalJSON() ([]byte, error)

type InsightsConfig added in v0.36.0 

type InsightsConfig struct {
	// QueryInsightsEnabled: Whether Query Insights feature is enabled.
	QueryInsightsEnabled bool `json:"queryInsightsEnabled,omitempty"`
	// QueryPlansPerMinute: Number of query execution plans captured by Insights
	// per minute for all queries combined. Default is 5.
	QueryPlansPerMinute int64 `json:"queryPlansPerMinute,omitempty"`
	// QueryStringLength: Maximum query length stored in bytes. Default value: 1024
	// bytes. Range: 256-4500 bytes. Query length more than this field value will
	// be truncated to this value. When unset, query length will be the default
	// value. Changing query length will restart the database.
	QueryStringLength int64 `json:"queryStringLength,omitempty"`
	// RecordApplicationTags: Whether Query Insights will record application tags
	// from query when enabled.
	RecordApplicationTags bool `json:"recordApplicationTags,omitempty"`
	// RecordClientAddress: Whether Query Insights will record client address when
	// enabled.
	RecordClientAddress bool `json:"recordClientAddress,omitempty"`
	// ForceSendFields is a list of field names (e.g. "QueryInsightsEnabled") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "QueryInsightsEnabled") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InsightsConfig: Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.

func (*InsightsConfig) MarshalJSON added in v0.36.0 

func (s *InsightsConfig) MarshalJSON() ([]byte, error)

type InstanceReference added in v0.55.0 

type InstanceReference struct {
	// Name: The name of the Cloud SQL instance being referenced. This does not
	// include the project ID.
	Name string `json:"name,omitempty"`
	// Project: The project ID of the Cloud SQL instance being referenced. The
	// default is the same project ID as the instance references it.
	Project string `json:"project,omitempty"`
	// Region: The region of the Cloud SQL instance being referenced.
	Region string `json:"region,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstanceReference: Reference to another Cloud SQL instance.

func (*InstanceReference) MarshalJSON added in v0.55.0 

func (s *InstanceReference) MarshalJSON() ([]byte, error)

type InstancesAcquireSsrsLeaseCall added in v0.170.0 

type InstancesAcquireSsrsLeaseCall struct {
	// contains filtered or unexported fields
}

func (*InstancesAcquireSsrsLeaseCall) Context added in v0.170.0 

func (c *InstancesAcquireSsrsLeaseCall) Context(ctx context.Context) *InstancesAcquireSsrsLeaseCall

Context sets the context to be used in this call's Do method.

func (*InstancesAcquireSsrsLeaseCall) Do added in v0.170.0 

func (c *InstancesAcquireSsrsLeaseCall) Do(opts ...googleapi.CallOption) (*SqlInstancesAcquireSsrsLeaseResponse, error)

Do executes the "sql.instances.acquireSsrsLease" call. Any non-2xx status code is an error. Response headers are in either *SqlInstancesAcquireSsrsLeaseResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesAcquireSsrsLeaseCall) Fields added in v0.170.0 

func (c *InstancesAcquireSsrsLeaseCall) Fields(s ...googleapi.Field) *InstancesAcquireSsrsLeaseCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesAcquireSsrsLeaseCall) Header added in v0.170.0 

func (c *InstancesAcquireSsrsLeaseCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesAcquireSsrsLeaseRequest added in v0.170.0 

type InstancesAcquireSsrsLeaseRequest struct {
	// AcquireSsrsLeaseContext: Contains details about the acquire SSRS lease
	// operation.
	AcquireSsrsLeaseContext *AcquireSsrsLeaseContext `json:"acquireSsrsLeaseContext,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AcquireSsrsLeaseContext") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AcquireSsrsLeaseContext") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesAcquireSsrsLeaseRequest: Request to acquire an SSRS lease for an instance.

func (*InstancesAcquireSsrsLeaseRequest) MarshalJSON added in v0.170.0 

func (s *InstancesAcquireSsrsLeaseRequest) MarshalJSON() ([]byte, error)

type InstancesAddServerCaCall 

type InstancesAddServerCaCall struct {
	// contains filtered or unexported fields
}

func (*InstancesAddServerCaCall) Context 

func (c *InstancesAddServerCaCall) Context(ctx context.Context) *InstancesAddServerCaCall

Context sets the context to be used in this call's Do method.

func (*InstancesAddServerCaCall) Do 

func (c *InstancesAddServerCaCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.addServerCa" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesAddServerCaCall) Fields 

func (c *InstancesAddServerCaCall) Fields(s ...googleapi.Field) *InstancesAddServerCaCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesAddServerCaCall) Header 

func (c *InstancesAddServerCaCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesCloneCall 

type InstancesCloneCall struct {
	// contains filtered or unexported fields
}

func (*InstancesCloneCall) Context 

func (c *InstancesCloneCall) Context(ctx context.Context) *InstancesCloneCall

Context sets the context to be used in this call's Do method.

func (*InstancesCloneCall) Do 

func (c *InstancesCloneCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.clone" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesCloneCall) Fields 

func (c *InstancesCloneCall) Fields(s ...googleapi.Field) *InstancesCloneCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesCloneCall) Header 

func (c *InstancesCloneCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesCloneRequest 

type InstancesCloneRequest struct {
	// CloneContext: Contains details about the clone operation.
	CloneContext *CloneContext `json:"cloneContext,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CloneContext") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CloneContext") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesCloneRequest: Database instance clone request.

func (*InstancesCloneRequest) MarshalJSON 

func (s *InstancesCloneRequest) MarshalJSON() ([]byte, error)

type InstancesDeleteCall 

type InstancesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*InstancesDeleteCall) Context 

func (c *InstancesDeleteCall) Context(ctx context.Context) *InstancesDeleteCall

Context sets the context to be used in this call's Do method.

func (*InstancesDeleteCall) Do 

func (c *InstancesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesDeleteCall) Fields 

func (c *InstancesDeleteCall) Fields(s ...googleapi.Field) *InstancesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesDeleteCall) Header 

func (c *InstancesDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesDemoteCall added in v0.151.0 

type InstancesDemoteCall struct {
	// contains filtered or unexported fields
}

func (*InstancesDemoteCall) Context added in v0.151.0 

func (c *InstancesDemoteCall) Context(ctx context.Context) *InstancesDemoteCall

Context sets the context to be used in this call's Do method.

func (*InstancesDemoteCall) Do added in v0.151.0 

func (c *InstancesDemoteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.demote" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesDemoteCall) Fields added in v0.151.0 

func (c *InstancesDemoteCall) Fields(s ...googleapi.Field) *InstancesDemoteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesDemoteCall) Header added in v0.151.0 

func (c *InstancesDemoteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesDemoteMasterCall 

type InstancesDemoteMasterCall struct {
	// contains filtered or unexported fields
}

func (*InstancesDemoteMasterCall) Context 

func (c *InstancesDemoteMasterCall) Context(ctx context.Context) *InstancesDemoteMasterCall

Context sets the context to be used in this call's Do method.

func (*InstancesDemoteMasterCall) Do 

func (c *InstancesDemoteMasterCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.demoteMaster" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesDemoteMasterCall) Fields 

func (c *InstancesDemoteMasterCall) Fields(s ...googleapi.Field) *InstancesDemoteMasterCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesDemoteMasterCall) Header 

func (c *InstancesDemoteMasterCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesDemoteMasterRequest 

type InstancesDemoteMasterRequest struct {
	// DemoteMasterContext: Contains details about the demoteMaster operation.
	DemoteMasterContext *DemoteMasterContext `json:"demoteMasterContext,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DemoteMasterContext") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DemoteMasterContext") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesDemoteMasterRequest: Database demote primary instance request.

func (*InstancesDemoteMasterRequest) MarshalJSON 

func (s *InstancesDemoteMasterRequest) MarshalJSON() ([]byte, error)

type InstancesDemoteRequest added in v0.151.0 

type InstancesDemoteRequest struct {
	// DemoteContext: Required. This context is used to demote an existing
	// standalone instance to be a Cloud SQL read replica for an external database
	// server.
	DemoteContext *DemoteContext `json:"demoteContext,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DemoteContext") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DemoteContext") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesDemoteRequest: This request is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.

func (*InstancesDemoteRequest) MarshalJSON added in v0.151.0 

func (s *InstancesDemoteRequest) MarshalJSON() ([]byte, error)

type InstancesExportCall 

type InstancesExportCall struct {
	// contains filtered or unexported fields
}

func (*InstancesExportCall) Context 

func (c *InstancesExportCall) Context(ctx context.Context) *InstancesExportCall

Context sets the context to be used in this call's Do method.

func (*InstancesExportCall) Do 

func (c *InstancesExportCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.export" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesExportCall) Fields 

func (c *InstancesExportCall) Fields(s ...googleapi.Field) *InstancesExportCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesExportCall) Header 

func (c *InstancesExportCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesExportRequest 

type InstancesExportRequest struct {
	// ExportContext: Contains details about the export operation.
	ExportContext *ExportContext `json:"exportContext,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExportContext") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExportContext") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesExportRequest: Database instance export request.

func (*InstancesExportRequest) MarshalJSON 

func (s *InstancesExportRequest) MarshalJSON() ([]byte, error)

type InstancesFailoverCall 

type InstancesFailoverCall struct {
	// contains filtered or unexported fields
}

func (*InstancesFailoverCall) Context 

func (c *InstancesFailoverCall) Context(ctx context.Context) *InstancesFailoverCall

Context sets the context to be used in this call's Do method.

func (*InstancesFailoverCall) Do 

func (c *InstancesFailoverCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.failover" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesFailoverCall) Fields 

func (c *InstancesFailoverCall) Fields(s ...googleapi.Field) *InstancesFailoverCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesFailoverCall) Header 

func (c *InstancesFailoverCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesFailoverRequest 

type InstancesFailoverRequest struct {
	// FailoverContext: Failover Context.
	FailoverContext *FailoverContext `json:"failoverContext,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FailoverContext") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FailoverContext") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesFailoverRequest: Instance failover request.

func (*InstancesFailoverRequest) MarshalJSON 

func (s *InstancesFailoverRequest) MarshalJSON() ([]byte, error)

type InstancesGetCall 

type InstancesGetCall struct {
	// contains filtered or unexported fields
}

func (*InstancesGetCall) Context 

func (c *InstancesGetCall) Context(ctx context.Context) *InstancesGetCall

Context sets the context to be used in this call's Do method.

func (*InstancesGetCall) Do 

func (c *InstancesGetCall) Do(opts ...googleapi.CallOption) (*DatabaseInstance, error)

Do executes the "sql.instances.get" call. Any non-2xx status code is an error. Response headers are in either *DatabaseInstance.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesGetCall) Fields 

func (c *InstancesGetCall) Fields(s ...googleapi.Field) *InstancesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesGetCall) Header 

func (c *InstancesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*InstancesGetCall) IfNoneMatch 

func (c *InstancesGetCall) IfNoneMatch(entityTag string) *InstancesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type InstancesImportCall 

type InstancesImportCall struct {
	// contains filtered or unexported fields
}

func (*InstancesImportCall) Context 

func (c *InstancesImportCall) Context(ctx context.Context) *InstancesImportCall

Context sets the context to be used in this call's Do method.

func (*InstancesImportCall) Do 

func (c *InstancesImportCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.import" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesImportCall) Fields 

func (c *InstancesImportCall) Fields(s ...googleapi.Field) *InstancesImportCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesImportCall) Header 

func (c *InstancesImportCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesImportRequest 

type InstancesImportRequest struct {
	// ImportContext: Contains details about the import operation.
	ImportContext *ImportContext `json:"importContext,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ImportContext") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ImportContext") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesImportRequest: Database instance import request.

func (*InstancesImportRequest) MarshalJSON 

func (s *InstancesImportRequest) MarshalJSON() ([]byte, error)

type InstancesInsertCall 

type InstancesInsertCall struct {
	// contains filtered or unexported fields
}

func (*InstancesInsertCall) Context 

func (c *InstancesInsertCall) Context(ctx context.Context) *InstancesInsertCall

Context sets the context to be used in this call's Do method.

func (*InstancesInsertCall) Do 

func (c *InstancesInsertCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.insert" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesInsertCall) Fields 

func (c *InstancesInsertCall) Fields(s ...googleapi.Field) *InstancesInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesInsertCall) Header 

func (c *InstancesInsertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesListCall 

type InstancesListCall struct {
	// contains filtered or unexported fields
}

func (*InstancesListCall) Context 

func (c *InstancesListCall) Context(ctx context.Context) *InstancesListCall

Context sets the context to be used in this call's Do method.

func (*InstancesListCall) Do 

func (c *InstancesListCall) Do(opts ...googleapi.CallOption) (*InstancesListResponse, error)

Do executes the "sql.instances.list" call. Any non-2xx status code is an error. Response headers are in either *InstancesListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesListCall) Fields 

func (c *InstancesListCall) Fields(s ...googleapi.Field) *InstancesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesListCall) Filter 

func (c *InstancesListCall) Filter(filter string) *InstancesListCall

Filter sets the optional parameter "filter": A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

func (*InstancesListCall) Header 

func (c *InstancesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*InstancesListCall) IfNoneMatch 

func (c *InstancesListCall) IfNoneMatch(entityTag string) *InstancesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*InstancesListCall) MaxResults 

func (c *InstancesListCall) MaxResults(maxResults int64) *InstancesListCall

MaxResults sets the optional parameter "maxResults": The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

func (*InstancesListCall) PageToken 

func (c *InstancesListCall) PageToken(pageToken string) *InstancesListCall

PageToken sets the optional parameter "pageToken": A previously-returned page token representing part of the larger set of results to view.

func (*InstancesListCall) Pages 

func (c *InstancesListCall) Pages(ctx context.Context, f func(*InstancesListResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type InstancesListResponse 

type InstancesListResponse struct {
	// Items: List of database instance resources.
	Items []*DatabaseInstance `json:"items,omitempty"`
	// Kind: This is always `sql#instancesList`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: The continuation token, used to page through large result
	// sets. Provide this value in a subsequent request to return the next page of
	// results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Warnings: List of warnings that occurred while handling the request.
	Warnings []*ApiWarning `json:"warnings,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Items") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesListResponse: Database instances list response.

func (*InstancesListResponse) MarshalJSON 

func (s *InstancesListResponse) MarshalJSON() ([]byte, error)

type InstancesListServerCasCall 

type InstancesListServerCasCall struct {
	// contains filtered or unexported fields
}

func (*InstancesListServerCasCall) Context 

func (c *InstancesListServerCasCall) Context(ctx context.Context) *InstancesListServerCasCall

Context sets the context to be used in this call's Do method.

func (*InstancesListServerCasCall) Do 

func (c *InstancesListServerCasCall) Do(opts ...googleapi.CallOption) (*InstancesListServerCasResponse, error)

Do executes the "sql.instances.listServerCas" call. Any non-2xx status code is an error. Response headers are in either *InstancesListServerCasResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesListServerCasCall) Fields 

func (c *InstancesListServerCasCall) Fields(s ...googleapi.Field) *InstancesListServerCasCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesListServerCasCall) Header 

func (c *InstancesListServerCasCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*InstancesListServerCasCall) IfNoneMatch 

func (c *InstancesListServerCasCall) IfNoneMatch(entityTag string) *InstancesListServerCasCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type InstancesListServerCasResponse 

type InstancesListServerCasResponse struct {
	ActiveVersion string `json:"activeVersion,omitempty"`
	// Certs: List of server CA certificates for the instance.
	Certs []*SslCert `json:"certs,omitempty"`
	// Kind: This is always `sql#instancesListServerCas`.
	Kind string `json:"kind,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ActiveVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ActiveVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesListServerCasResponse: Instances ListServerCas response.

func (*InstancesListServerCasResponse) MarshalJSON 

func (s *InstancesListServerCasResponse) MarshalJSON() ([]byte, error)

type InstancesPatchCall 

type InstancesPatchCall struct {
	// contains filtered or unexported fields
}

func (*InstancesPatchCall) Context 

func (c *InstancesPatchCall) Context(ctx context.Context) *InstancesPatchCall

Context sets the context to be used in this call's Do method.

func (*InstancesPatchCall) Do 

func (c *InstancesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesPatchCall) Fields 

func (c *InstancesPatchCall) Fields(s ...googleapi.Field) *InstancesPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesPatchCall) Header 

func (c *InstancesPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesPromoteReplicaCall 

type InstancesPromoteReplicaCall struct {
	// contains filtered or unexported fields
}

func (*InstancesPromoteReplicaCall) Context 

func (c *InstancesPromoteReplicaCall) Context(ctx context.Context) *InstancesPromoteReplicaCall

Context sets the context to be used in this call's Do method.

func (*InstancesPromoteReplicaCall) Do 

func (c *InstancesPromoteReplicaCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.promoteReplica" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesPromoteReplicaCall) Failover added in v0.148.0 

func (c *InstancesPromoteReplicaCall) Failover(failover bool) *InstancesPromoteReplicaCall

Failover sets the optional parameter "failover": Set to true to invoke a replica failover to the designated DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online. If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance. Only applicable to MySQL.

func (*InstancesPromoteReplicaCall) Fields 

func (c *InstancesPromoteReplicaCall) Fields(s ...googleapi.Field) *InstancesPromoteReplicaCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesPromoteReplicaCall) Header 

func (c *InstancesPromoteReplicaCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesReencryptCall added in v0.128.0 

type InstancesReencryptCall struct {
	// contains filtered or unexported fields
}

func (*InstancesReencryptCall) Context added in v0.128.0 

func (c *InstancesReencryptCall) Context(ctx context.Context) *InstancesReencryptCall

Context sets the context to be used in this call's Do method.

func (*InstancesReencryptCall) Do added in v0.128.0 

func (c *InstancesReencryptCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.reencrypt" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesReencryptCall) Fields added in v0.128.0 

func (c *InstancesReencryptCall) Fields(s ...googleapi.Field) *InstancesReencryptCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesReencryptCall) Header added in v0.128.0 

func (c *InstancesReencryptCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesReencryptRequest added in v0.128.0 

type InstancesReencryptRequest struct {
	// BackupReencryptionConfig: Configuration specific to backup re-encryption
	BackupReencryptionConfig *BackupReencryptionConfig `json:"backupReencryptionConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BackupReencryptionConfig")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackupReencryptionConfig") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesReencryptRequest: Database Instance reencrypt request.

func (*InstancesReencryptRequest) MarshalJSON added in v0.128.0 

func (s *InstancesReencryptRequest) MarshalJSON() ([]byte, error)

type InstancesReleaseSsrsLeaseCall added in v0.170.0 

type InstancesReleaseSsrsLeaseCall struct {
	// contains filtered or unexported fields
}

func (*InstancesReleaseSsrsLeaseCall) Context added in v0.170.0 

func (c *InstancesReleaseSsrsLeaseCall) Context(ctx context.Context) *InstancesReleaseSsrsLeaseCall

Context sets the context to be used in this call's Do method.

func (*InstancesReleaseSsrsLeaseCall) Do added in v0.170.0 

func (c *InstancesReleaseSsrsLeaseCall) Do(opts ...googleapi.CallOption) (*SqlInstancesReleaseSsrsLeaseResponse, error)

Do executes the "sql.instances.releaseSsrsLease" call. Any non-2xx status code is an error. Response headers are in either *SqlInstancesReleaseSsrsLeaseResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesReleaseSsrsLeaseCall) Fields added in v0.170.0 

func (c *InstancesReleaseSsrsLeaseCall) Fields(s ...googleapi.Field) *InstancesReleaseSsrsLeaseCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesReleaseSsrsLeaseCall) Header added in v0.170.0 

func (c *InstancesReleaseSsrsLeaseCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesResetSslConfigCall 

type InstancesResetSslConfigCall struct {
	// contains filtered or unexported fields
}

func (*InstancesResetSslConfigCall) Context 

func (c *InstancesResetSslConfigCall) Context(ctx context.Context) *InstancesResetSslConfigCall

Context sets the context to be used in this call's Do method.

func (*InstancesResetSslConfigCall) Do 

func (c *InstancesResetSslConfigCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.resetSslConfig" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesResetSslConfigCall) Fields 

func (c *InstancesResetSslConfigCall) Fields(s ...googleapi.Field) *InstancesResetSslConfigCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesResetSslConfigCall) Header 

func (c *InstancesResetSslConfigCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesRestartCall 

type InstancesRestartCall struct {
	// contains filtered or unexported fields
}

func (*InstancesRestartCall) Context 

func (c *InstancesRestartCall) Context(ctx context.Context) *InstancesRestartCall

Context sets the context to be used in this call's Do method.

func (*InstancesRestartCall) Do 

func (c *InstancesRestartCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.restart" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesRestartCall) Fields 

func (c *InstancesRestartCall) Fields(s ...googleapi.Field) *InstancesRestartCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesRestartCall) Header 

func (c *InstancesRestartCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesRestoreBackupCall 

type InstancesRestoreBackupCall struct {
	// contains filtered or unexported fields
}

func (*InstancesRestoreBackupCall) Context 

func (c *InstancesRestoreBackupCall) Context(ctx context.Context) *InstancesRestoreBackupCall

Context sets the context to be used in this call's Do method.

func (*InstancesRestoreBackupCall) Do 

func (c *InstancesRestoreBackupCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.restoreBackup" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesRestoreBackupCall) Fields 

func (c *InstancesRestoreBackupCall) Fields(s ...googleapi.Field) *InstancesRestoreBackupCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesRestoreBackupCall) Header 

func (c *InstancesRestoreBackupCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesRestoreBackupRequest 

type InstancesRestoreBackupRequest struct {
	// RestoreBackupContext: Parameters required to perform the restore backup
	// operation.
	RestoreBackupContext *RestoreBackupContext `json:"restoreBackupContext,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RestoreBackupContext") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "RestoreBackupContext") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesRestoreBackupRequest: Database instance restore backup request.

func (*InstancesRestoreBackupRequest) MarshalJSON 

func (s *InstancesRestoreBackupRequest) MarshalJSON() ([]byte, error)

type InstancesRotateServerCaCall 

type InstancesRotateServerCaCall struct {
	// contains filtered or unexported fields
}

func (*InstancesRotateServerCaCall) Context 

func (c *InstancesRotateServerCaCall) Context(ctx context.Context) *InstancesRotateServerCaCall

Context sets the context to be used in this call's Do method.

func (*InstancesRotateServerCaCall) Do 

func (c *InstancesRotateServerCaCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.rotateServerCa" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesRotateServerCaCall) Fields 

func (c *InstancesRotateServerCaCall) Fields(s ...googleapi.Field) *InstancesRotateServerCaCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesRotateServerCaCall) Header 

func (c *InstancesRotateServerCaCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesRotateServerCaRequest 

type InstancesRotateServerCaRequest struct {
	// RotateServerCaContext: Contains details about the rotate server CA
	// operation.
	RotateServerCaContext *RotateServerCaContext `json:"rotateServerCaContext,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RotateServerCaContext") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "RotateServerCaContext") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesRotateServerCaRequest: Rotate Server CA request.

func (*InstancesRotateServerCaRequest) MarshalJSON 

func (s *InstancesRotateServerCaRequest) MarshalJSON() ([]byte, error)

type InstancesService 

type InstancesService struct {
	// contains filtered or unexported fields
}

func NewInstancesService 

func NewInstancesService(s *Service) *InstancesService

func (*InstancesService) AcquireSsrsLease added in v0.170.0 

func (r *InstancesService) AcquireSsrsLease(project string, instance string, instancesacquiressrsleaserequest *InstancesAcquireSsrsLeaseRequest) *InstancesAcquireSsrsLeaseCall

AcquireSsrsLease: Acquire a lease for the setup of SQL Server Reporting Services (SSRS).

  • instance: Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id).
  • project: ID of the project that contains the instance (Example: project-id).

func (*InstancesService) AddServerCa 

func (r *InstancesService) AddServerCa(project string, instance string) *InstancesAddServerCaCall

AddServerCa: Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*InstancesService) Clone 

func (r *InstancesService) Clone(project string, instance string, instancesclonerequest *InstancesCloneRequest) *InstancesCloneCall

Clone: Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

  • instance: The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
  • project: Project ID of the source as well as the clone Cloud SQL instance.

func (*InstancesService) Delete 

func (r *InstancesService) Delete(project string, instance string) *InstancesDeleteCall

Delete: Deletes a Cloud SQL instance.

  • instance: Cloud SQL instance ID. This does not include the project ID.
  • project: Project ID of the project that contains the instance to be deleted.

func (*InstancesService) Demote added in v0.151.0 

func (r *InstancesService) Demote(project string, instance string, instancesdemoterequest *InstancesDemoteRequest) *InstancesDemoteCall

Demote: Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.

- instance: The name of the Cloud SQL instance. - project: The project ID of the project that contains the instance.

func (*InstancesService) DemoteMaster 

func (r *InstancesService) DemoteMaster(project string, instance string, instancesdemotemasterrequest *InstancesDemoteMasterRequest) *InstancesDemoteMasterCall

DemoteMaster: Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.

- instance: Cloud SQL instance name. - project: ID of the project that contains the instance.

func (*InstancesService) Export 

func (r *InstancesService) Export(project string, instance string, instancesexportrequest *InstancesExportRequest) *InstancesExportCall

Export: Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.

  • instance: The Cloud SQL instance ID. This doesn't include the project ID.
  • project: Project ID of the project that contains the instance to be exported.

func (*InstancesService) Failover 

func (r *InstancesService) Failover(project string, instance string, instancesfailoverrequest *InstancesFailoverRequest) *InstancesFailoverCall

Failover: Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the Overview of high availability (https://cloud.google.com/sql/docs/mysql/high-availability) page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: ID of the project that contains the read replica.

func (*InstancesService) Get 

func (r *InstancesService) Get(project string, instance string) *InstancesGetCall

Get: Retrieves a resource containing information about a Cloud SQL instance.

- instance: Database instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*InstancesService) Import 

func (r *InstancesService) Import(project string, instance string, instancesimportrequest *InstancesImportRequest) *InstancesImportCall

Import: Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*InstancesService) Insert 

func (r *InstancesService) Insert(project string, databaseinstance *DatabaseInstance) *InstancesInsertCall

Insert: Creates a new Cloud SQL instance.

  • project: Project ID of the project to which the newly created Cloud SQL instances should belong.

func (*InstancesService) List 

func (r *InstancesService) List(project string) *InstancesListCall

List: Lists instances under a given project.

- project: Project ID of the project for which to list Cloud SQL instances.

func (*InstancesService) ListServerCas 

func (r *InstancesService) ListServerCas(project string, instance string) *InstancesListServerCasCall

ListServerCas: Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*InstancesService) Patch 

func (r *InstancesService) Patch(project string, instance string, databaseinstance *DatabaseInstance) *InstancesPatchCall

Patch: Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*InstancesService) PromoteReplica 

func (r *InstancesService) PromoteReplica(project string, instance string) *InstancesPromoteReplicaCall

PromoteReplica: Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.

- instance: Cloud SQL read replica instance name. - project: ID of the project that contains the read replica.

func (*InstancesService) Reencrypt added in v0.128.0 

func (r *InstancesService) Reencrypt(project string, instance string, instancesreencryptrequest *InstancesReencryptRequest) *InstancesReencryptCall

Reencrypt: Reencrypt CMEK instance with latest key version.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: ID of the project that contains the instance.

func (*InstancesService) ReleaseSsrsLease added in v0.170.0 

func (r *InstancesService) ReleaseSsrsLease(project string, instance string) *InstancesReleaseSsrsLeaseCall

ReleaseSsrsLease: Release a lease for the setup of SQL Server Reporting Services (SSRS).

  • instance: The Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id).
  • project: The ID of the project that contains the instance (Example: project-id).

func (*InstancesService) ResetSslConfig 

func (r *InstancesService) ResetSslConfig(project string, instance string) *InstancesResetSslConfigCall

ResetSslConfig: Deletes all client certificates and generates a new server SSL certificate for the instance.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*InstancesService) Restart 

func (r *InstancesService) Restart(project string, instance string) *InstancesRestartCall

Restart: Restarts a Cloud SQL instance.

  • instance: Cloud SQL instance ID. This does not include the project ID.
  • project: Project ID of the project that contains the instance to be restarted.

func (*InstancesService) RestoreBackup 

func (r *InstancesService) RestoreBackup(project string, instance string, instancesrestorebackuprequest *InstancesRestoreBackupRequest) *InstancesRestoreBackupCall

RestoreBackup: Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*InstancesService) RotateServerCa 

func (r *InstancesService) RotateServerCa(project string, instance string, instancesrotateservercarequest *InstancesRotateServerCaRequest) *InstancesRotateServerCaCall

RotateServerCa: Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*InstancesService) StartReplica 

func (r *InstancesService) StartReplica(project string, instance string) *InstancesStartReplicaCall

StartReplica: Starts the replication in the read replica instance.

- instance: Cloud SQL read replica instance name. - project: ID of the project that contains the read replica.

func (*InstancesService) StopReplica 

func (r *InstancesService) StopReplica(project string, instance string) *InstancesStopReplicaCall

StopReplica: Stops the replication in the read replica instance.

- instance: Cloud SQL read replica instance name. - project: ID of the project that contains the read replica.

func (*InstancesService) Switchover added in v0.148.0 

func (r *InstancesService) Switchover(project string, instance string) *InstancesSwitchoverCall

Switchover: Switches over from the primary instance to the designated DR replica instance.

- instance: Cloud SQL read replica instance name. - project: ID of the project that contains the replica.

func (*InstancesService) TruncateLog 

func (r *InstancesService) TruncateLog(project string, instance string, instancestruncatelogrequest *InstancesTruncateLogRequest) *InstancesTruncateLogCall

TruncateLog: Truncate MySQL general and slow query log tables MySQL only.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the Cloud SQL project.

func (*InstancesService) Update 

func (r *InstancesService) Update(project string, instance string, databaseinstance *DatabaseInstance) *InstancesUpdateCall

Update: Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

type InstancesStartReplicaCall 

type InstancesStartReplicaCall struct {
	// contains filtered or unexported fields
}

func (*InstancesStartReplicaCall) Context 

func (c *InstancesStartReplicaCall) Context(ctx context.Context) *InstancesStartReplicaCall

Context sets the context to be used in this call's Do method.

func (*InstancesStartReplicaCall) Do 

func (c *InstancesStartReplicaCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.startReplica" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesStartReplicaCall) Fields 

func (c *InstancesStartReplicaCall) Fields(s ...googleapi.Field) *InstancesStartReplicaCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesStartReplicaCall) Header 

func (c *InstancesStartReplicaCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesStopReplicaCall 

type InstancesStopReplicaCall struct {
	// contains filtered or unexported fields
}

func (*InstancesStopReplicaCall) Context 

func (c *InstancesStopReplicaCall) Context(ctx context.Context) *InstancesStopReplicaCall

Context sets the context to be used in this call's Do method.

func (*InstancesStopReplicaCall) Do 

func (c *InstancesStopReplicaCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.stopReplica" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesStopReplicaCall) Fields 

func (c *InstancesStopReplicaCall) Fields(s ...googleapi.Field) *InstancesStopReplicaCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesStopReplicaCall) Header 

func (c *InstancesStopReplicaCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesSwitchoverCall added in v0.148.0 

type InstancesSwitchoverCall struct {
	// contains filtered or unexported fields
}

func (*InstancesSwitchoverCall) Context added in v0.148.0 

func (c *InstancesSwitchoverCall) Context(ctx context.Context) *InstancesSwitchoverCall

Context sets the context to be used in this call's Do method.

func (*InstancesSwitchoverCall) DbTimeout added in v0.148.0 

func (c *InstancesSwitchoverCall) DbTimeout(dbTimeout string) *InstancesSwitchoverCall

DbTimeout sets the optional parameter "dbTimeout": (MySQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24 hours.

func (*InstancesSwitchoverCall) Do added in v0.148.0 

func (c *InstancesSwitchoverCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.switchover" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesSwitchoverCall) Fields added in v0.148.0 

func (c *InstancesSwitchoverCall) Fields(s ...googleapi.Field) *InstancesSwitchoverCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesSwitchoverCall) Header added in v0.148.0 

func (c *InstancesSwitchoverCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesTruncateLogCall 

type InstancesTruncateLogCall struct {
	// contains filtered or unexported fields
}

func (*InstancesTruncateLogCall) Context 

func (c *InstancesTruncateLogCall) Context(ctx context.Context) *InstancesTruncateLogCall

Context sets the context to be used in this call's Do method.

func (*InstancesTruncateLogCall) Do 

func (c *InstancesTruncateLogCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.truncateLog" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesTruncateLogCall) Fields 

func (c *InstancesTruncateLogCall) Fields(s ...googleapi.Field) *InstancesTruncateLogCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesTruncateLogCall) Header 

func (c *InstancesTruncateLogCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type InstancesTruncateLogRequest 

type InstancesTruncateLogRequest struct {
	// TruncateLogContext: Contains details about the truncate log operation.
	TruncateLogContext *TruncateLogContext `json:"truncateLogContext,omitempty"`
	// ForceSendFields is a list of field names (e.g. "TruncateLogContext") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "TruncateLogContext") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InstancesTruncateLogRequest: Instance truncate log request.

func (*InstancesTruncateLogRequest) MarshalJSON 

func (s *InstancesTruncateLogRequest) MarshalJSON() ([]byte, error)

type InstancesUpdateCall 

type InstancesUpdateCall struct {
	// contains filtered or unexported fields
}

func (*InstancesUpdateCall) Context 

func (c *InstancesUpdateCall) Context(ctx context.Context) *InstancesUpdateCall

Context sets the context to be used in this call's Do method.

func (*InstancesUpdateCall) Do 

func (c *InstancesUpdateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.instances.update" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*InstancesUpdateCall) Fields 

func (c *InstancesUpdateCall) Fields(s ...googleapi.Field) *InstancesUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*InstancesUpdateCall) Header 

func (c *InstancesUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type IpConfiguration 

type IpConfiguration struct {
	// AllocatedIpRange: The name of the allocated ip range for the private ip
	// Cloud SQL instance. For example: "google-managed-services-default". If set,
	// the instance ip will be created in the allocated range. The range name must
	// comply with RFC 1035 (https://tools.ietf.org/html/rfc1035). Specifically,
	// the name must be 1-63 characters long and match the regular expression
	// `[a-z]([-a-z0-9]*[a-z0-9])?.`
	AllocatedIpRange string `json:"allocatedIpRange,omitempty"`
	// AuthorizedNetworks: The list of external networks that are allowed to
	// connect to the instance using the IP. In 'CIDR' notation, also known as
	// 'slash' notation (for example: `157.197.200.0/24`).
	AuthorizedNetworks []*AclEntry `json:"authorizedNetworks,omitempty"`
	// EnablePrivatePathForGoogleCloudServices: Controls connectivity to private IP
	// instances from Google services, such as BigQuery.
	EnablePrivatePathForGoogleCloudServices bool `json:"enablePrivatePathForGoogleCloudServices,omitempty"`
	// Ipv4Enabled: Whether the instance is assigned a public IP address or not.
	Ipv4Enabled bool `json:"ipv4Enabled,omitempty"`
	// PrivateNetwork: The resource link for the VPC network from which the Cloud
	// SQL instance is accessible for private IP. For example,
	// `/projects/myProject/global/networks/default`. This setting can be updated,
	// but it cannot be removed after it is set.
	PrivateNetwork string `json:"privateNetwork,omitempty"`
	// PscConfig: PSC settings for this instance.
	PscConfig *PscConfig `json:"pscConfig,omitempty"`
	// RequireSsl: Use `ssl_mode` instead. Whether SSL/TLS connections over IP are
	// enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS
	// connections. For SSL/TLS connections, the client certificate won't be
	// verified. If set to true, then only allow connections encrypted with SSL/TLS
	// and with valid client certificates. If you want to enforce SSL/TLS without
	// enforcing the requirement for valid client certificates, then use the
	// `ssl_mode` flag instead of the legacy `require_ssl` flag.
	RequireSsl bool `json:"requireSsl,omitempty"`
	// SslMode: Specify how SSL/TLS is enforced in database connections. If you
	// must use the `require_ssl` flag for backward compatibility, then only the
	// following value pairs are valid: For PostgreSQL and MySQL: *
	// `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` *
	// `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` *
	// `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For
	// SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and
	// `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The
	// value of `ssl_mode` has priority over the value of `require_ssl`. For
	// example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`,
	// `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while
	// `require_ssl=false` means accept both non-SSL and SSL connections. In this
	// case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL
	// connections.
	//
	// Possible values:
	//   "SSL_MODE_UNSPECIFIED" - The SSL mode is unknown.
	//   "ALLOW_UNENCRYPTED_AND_ENCRYPTED" - Allow non-SSL/non-TLS and SSL/TLS
	// connections. For SSL connections to MySQL and PostgreSQL, the client
	// certificate isn't verified. When this value is used, the legacy
	// `require_ssl` flag must be false or cleared to avoid a conflict between the
	// values of the two flags.
	//   "ENCRYPTED_ONLY" - Only allow connections encrypted with SSL/TLS. For SSL
	// connections to MySQL and PostgreSQL, the client certificate isn't verified.
	// When this value is used, the legacy `require_ssl` flag must be false or
	// cleared to avoid a conflict between the values of the two flags.
	//   "TRUSTED_CLIENT_CERTIFICATE_REQUIRED" - Only allow connections encrypted
	// with SSL/TLS and with valid client certificates. When this value is used,
	// the legacy `require_ssl` flag must be true or cleared to avoid the conflict
	// between values of two flags. PostgreSQL clients or users that connect using
	// IAM database authentication must use either the [Cloud SQL Auth
	// Proxy](https://cloud.google.com/sql/docs/postgres/connect-auth-proxy) or
	// [Cloud SQL
	// Connectors](https://cloud.google.com/sql/docs/postgres/connect-connectors)
	// to enforce client identity verification. Only applicable to MySQL and
	// PostgreSQL. Not applicable to SQL Server.
	SslMode string `json:"sslMode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllocatedIpRange") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllocatedIpRange") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

IpConfiguration: IP Management configuration.

func (*IpConfiguration) MarshalJSON 

func (s *IpConfiguration) MarshalJSON() ([]byte, error)

type IpMapping 

type IpMapping struct {
	// IpAddress: The IP address assigned.
	IpAddress string `json:"ipAddress,omitempty"`
	// TimeToRetire: The due time for this IP to be retired in RFC 3339
	// (https://tools.ietf.org/html/rfc3339) format, for example
	// `2012-11-15T16:19:00.094Z`. This field is only available when the IP is
	// scheduled to be retired.
	TimeToRetire string `json:"timeToRetire,omitempty"`
	// Type: The type of this IP address. A `PRIMARY` address is a public address
	// that can accept incoming connections. A `PRIVATE` address is a private
	// address that can accept incoming connections. An `OUTGOING` address is the
	// source address of connections originating from the instance, if supported.
	//
	// Possible values:
	//   "SQL_IP_ADDRESS_TYPE_UNSPECIFIED" - This is an unknown IP address type.
	//   "PRIMARY" - IP address the customer is supposed to connect to. Usually
	// this is the load balancer's IP address
	//   "OUTGOING" - Source IP address of the connection a read replica
	// establishes to its external primary instance. This IP address can be
	// allowlisted by the customer in case it has a firewall that filters incoming
	// connection to its on premises primary instance.
	//   "PRIVATE" - Private IP used when using private IPs and network peering.
	//   "MIGRATED_1ST_GEN" - V1 IP of a migrated instance. We want the user to
	// decommission this IP as soon as the migration is complete. Note: V1
	// instances with V1 ip addresses will be counted as PRIMARY.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "IpAddress") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "IpAddress") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

IpMapping: Database instance IP mapping

func (*IpMapping) MarshalJSON 

func (s *IpMapping) MarshalJSON() ([]byte, error)

type LocationPreference 

type LocationPreference struct {
	// FollowGaeApplication: The App Engine application to follow, it must be in
	// the same region as the Cloud SQL instance. WARNING: Changing this might
	// restart the instance.
	FollowGaeApplication string `json:"followGaeApplication,omitempty"`
	// Kind: This is always `sql#locationPreference`.
	Kind string `json:"kind,omitempty"`
	// SecondaryZone: The preferred Compute Engine zone for the secondary/failover
	// (for example: us-central1-a, us-central1-b, etc.). To disable this field,
	// set it to 'no_secondary_zone'.
	SecondaryZone string `json:"secondaryZone,omitempty"`
	// Zone: The preferred Compute Engine zone (for example: us-central1-a,
	// us-central1-b, etc.). WARNING: Changing this might restart the instance.
	Zone string `json:"zone,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FollowGaeApplication") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FollowGaeApplication") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

LocationPreference: Preferred location. This specifies where a Cloud SQL instance is located. 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.

func (*LocationPreference) MarshalJSON 

func (s *LocationPreference) MarshalJSON() ([]byte, error)

type MaintenanceWindow 

type MaintenanceWindow struct {
	// Day: day of week (1-7), starting on Monday.
	Day int64 `json:"day,omitempty"`
	// Hour: hour of day - 0 to 23.
	Hour int64 `json:"hour,omitempty"`
	// Kind: This is always `sql#maintenanceWindow`.
	Kind string `json:"kind,omitempty"`
	// UpdateTrack: Maintenance timing setting: `canary` (Earlier) or `stable`
	// (Later). Learn more
	// (https://cloud.google.com/sql/docs/mysql/instance-settings#maintenance-timing-2ndgen).
	//
	// Possible values:
	//   "SQL_UPDATE_TRACK_UNSPECIFIED" - This is an unknown maintenance timing
	// preference.
	//   "canary" - For instance update that requires a restart, this update track
	// indicates your instance prefer to restart for new version early in
	// maintenance window.
	//   "stable" - For instance update that requires a restart, this update track
	// indicates your instance prefer to let Cloud SQL choose the timing of restart
	// (within its Maintenance window, if applicable).
	//   "week5" - For instance update that requires a restart, this update track
	// indicates your instance prefer to let Cloud SQL choose the timing of restart
	// (within its Maintenance window, if applicable) to be at least 5 weeks after
	// the notification.
	UpdateTrack string `json:"updateTrack,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Day") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Day") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MaintenanceWindow: Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes.

func (*MaintenanceWindow) MarshalJSON 

func (s *MaintenanceWindow) MarshalJSON() ([]byte, error)

type MySqlReplicaConfiguration 

type MySqlReplicaConfiguration struct {
	// CaCertificate: PEM representation of the trusted CA's x509 certificate.
	CaCertificate string `json:"caCertificate,omitempty"`
	// ClientCertificate: PEM representation of the replica's x509 certificate.
	ClientCertificate string `json:"clientCertificate,omitempty"`
	// ClientKey: PEM representation of the replica's private key. The
	// corresponsing public key is encoded in the client's certificate.
	ClientKey string `json:"clientKey,omitempty"`
	// ConnectRetryInterval: Seconds to wait between connect retries. MySQL's
	// default is 60 seconds.
	ConnectRetryInterval int64 `json:"connectRetryInterval,omitempty"`
	// DumpFilePath: Path to a SQL dump file in Google Cloud Storage from which the
	// replica instance is to be created. The URI is in the form
	// gs://bucketName/fileName. Compressed gzip files (.gz) are also supported.
	// Dumps have the binlog co-ordinates from which replication begins. This can
	// be accomplished by setting --master-data to 1 when using mysqldump.
	DumpFilePath string `json:"dumpFilePath,omitempty"`
	// Kind: This is always `sql#mysqlReplicaConfiguration`.
	Kind string `json:"kind,omitempty"`
	// MasterHeartbeatPeriod: Interval in milliseconds between replication
	// heartbeats.
	MasterHeartbeatPeriod int64 `json:"masterHeartbeatPeriod,omitempty,string"`
	// Password: The password for the replication connection.
	Password string `json:"password,omitempty"`
	// SslCipher: A list of permissible ciphers to use for SSL encryption.
	SslCipher string `json:"sslCipher,omitempty"`
	// Username: The username for the replication connection.
	Username string `json:"username,omitempty"`
	// VerifyServerCertificate: Whether or not to check the primary instance's
	// Common Name value in the certificate that it sends during the SSL handshake.
	VerifyServerCertificate bool `json:"verifyServerCertificate,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CaCertificate") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CaCertificate") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MySqlReplicaConfiguration: Read-replica configuration specific to MySQL databases.

func (*MySqlReplicaConfiguration) MarshalJSON 

func (s *MySqlReplicaConfiguration) MarshalJSON() ([]byte, error)

type MySqlSyncConfig added in v0.53.0 

type MySqlSyncConfig struct {
	// InitialSyncFlags: Flags to use for the initial dump.
	InitialSyncFlags []*SyncFlags `json:"initialSyncFlags,omitempty"`
	// ForceSendFields is a list of field names (e.g. "InitialSyncFlags") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "InitialSyncFlags") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MySqlSyncConfig: MySQL-specific external server sync settings.

func (*MySqlSyncConfig) MarshalJSON added in v0.55.0 

func (s *MySqlSyncConfig) MarshalJSON() ([]byte, error)

type OnPremisesConfiguration 

type OnPremisesConfiguration struct {
	// CaCertificate: PEM representation of the trusted CA's x509 certificate.
	CaCertificate string `json:"caCertificate,omitempty"`
	// ClientCertificate: PEM representation of the replica's x509 certificate.
	ClientCertificate string `json:"clientCertificate,omitempty"`
	// ClientKey: PEM representation of the replica's private key. The
	// corresponsing public key is encoded in the client's certificate.
	ClientKey string `json:"clientKey,omitempty"`
	// DumpFilePath: The dump file to create the Cloud SQL replica.
	DumpFilePath string `json:"dumpFilePath,omitempty"`
	// HostPort: The host and port of the on-premises instance in host:port format
	HostPort string `json:"hostPort,omitempty"`
	// Kind: This is always `sql#onPremisesConfiguration`.
	Kind string `json:"kind,omitempty"`
	// Password: The password for connecting to on-premises instance.
	Password string `json:"password,omitempty"`
	// SourceInstance: The reference to Cloud SQL instance if the source is Cloud
	// SQL.
	SourceInstance *InstanceReference `json:"sourceInstance,omitempty"`
	// Username: The username for connecting to on-premises instance.
	Username string `json:"username,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CaCertificate") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CaCertificate") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OnPremisesConfiguration: On-premises instance configuration.

func (*OnPremisesConfiguration) MarshalJSON 

func (s *OnPremisesConfiguration) MarshalJSON() ([]byte, error)

type Operation 

type Operation struct {
	// AcquireSsrsLeaseContext: The context for acquire SSRS lease operation, if
	// applicable.
	AcquireSsrsLeaseContext *AcquireSsrsLeaseContext `json:"acquireSsrsLeaseContext,omitempty"`
	// ApiWarning: An Admin API warning message.
	ApiWarning *ApiWarning `json:"apiWarning,omitempty"`
	// BackupContext: The context for backup operation, if applicable.
	BackupContext *BackupContext `json:"backupContext,omitempty"`
	// EndTime: 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`.
	EndTime string `json:"endTime,omitempty"`
	// Error: If errors occurred during processing of this operation, this field
	// will be populated.
	Error *OperationErrors `json:"error,omitempty"`
	// ExportContext: The context for export operation, if applicable.
	ExportContext *ExportContext `json:"exportContext,omitempty"`
	// ImportContext: The context for import operation, if applicable.
	ImportContext *ImportContext `json:"importContext,omitempty"`
	// InsertTime: 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`.
	InsertTime string `json:"insertTime,omitempty"`
	// Kind: This is always `sql#operation`.
	Kind string `json:"kind,omitempty"`
	// Name: An identifier that uniquely identifies the operation. You can use this
	// identifier to retrieve the Operations resource that has information about
	// the operation.
	Name string `json:"name,omitempty"`
	// OperationType: 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`
	//
	// Possible values:
	//   "SQL_OPERATION_TYPE_UNSPECIFIED" - Unknown operation type.
	//   "IMPORT" - Imports data into a Cloud SQL instance.
	//   "EXPORT" - Exports data from a Cloud SQL instance to a Cloud Storage
	// bucket.
	//   "CREATE" - Creates a new Cloud SQL instance.
	//   "UPDATE" - Updates the settings of a Cloud SQL instance.
	//   "DELETE" - Deletes a Cloud SQL instance.
	//   "RESTART" - Restarts the Cloud SQL instance.
	//   "BACKUP"
	//   "SNAPSHOT"
	//   "BACKUP_VOLUME" - Performs instance backup.
	//   "DELETE_VOLUME" - Deletes an instance backup.
	//   "RESTORE_VOLUME" - Restores an instance backup.
	//   "INJECT_USER" - Injects a privileged user in mysql for MOB instances.
	//   "CLONE" - Clones a Cloud SQL instance.
	//   "STOP_REPLICA" - Stops replication on a Cloud SQL read replica instance.
	//   "START_REPLICA" - Starts replication on a Cloud SQL read replica instance.
	//   "PROMOTE_REPLICA" - Promotes a Cloud SQL replica instance.
	//   "CREATE_REPLICA" - Creates a Cloud SQL replica instance.
	//   "CREATE_USER" - Creates a new user in a Cloud SQL instance.
	//   "DELETE_USER" - Deletes a user from a Cloud SQL instance.
	//   "UPDATE_USER" - Updates an existing user in a Cloud SQL instance.
	//   "CREATE_DATABASE" - Creates a database in the Cloud SQL instance.
	//   "DELETE_DATABASE" - Deletes a database in the Cloud SQL instance.
	//   "UPDATE_DATABASE" - Updates a database in the Cloud SQL instance.
	//   "FAILOVER" - Performs failover of an HA-enabled Cloud SQL failover
	// replica.
	//   "DELETE_BACKUP" - Deletes the backup taken by a backup run.
	//   "RECREATE_REPLICA"
	//   "TRUNCATE_LOG" - Truncates a general or slow log table in MySQL.
	//   "DEMOTE_MASTER" - Demotes the stand-alone instance to be a Cloud SQL read
	// replica for an external database server.
	//   "MAINTENANCE" - Indicates that the instance is currently in maintenance.
	// Maintenance typically causes the instance to be unavailable for 1-3 minutes.
	//   "ENABLE_PRIVATE_IP" - This field is deprecated, and will be removed in
	// future version of API.
	//   "DEFER_MAINTENANCE"
	//   "CREATE_CLONE" - Creates clone instance.
	//   "RESCHEDULE_MAINTENANCE" - Reschedule maintenance to another time.
	//   "START_EXTERNAL_SYNC" - Starts external sync of a Cloud SQL EM replica to
	// an external primary instance.
	//   "LOG_CLEANUP" - Recovers logs from an instance's old data disk.
	//   "AUTO_RESTART" - Performs auto-restart of an HA-enabled Cloud SQL database
	// for auto recovery.
	//   "REENCRYPT" - Re-encrypts CMEK instances with latest key version.
	//   "SWITCHOVER" - Switches the roles of the primary and replica pair. The
	// target instance should be the replica.
	//   "ACQUIRE_SSRS_LEASE" - Acquire a lease for the setup of SQL Server
	// Reporting Services (SSRS).
	//   "RELEASE_SSRS_LEASE" - Release a lease for the setup of SQL Server
	// Reporting Services (SSRS).
	//   "RECONFIGURE_OLD_PRIMARY" - Reconfigures old primary after a promote
	// replica operation. Effect of a promote operation to the old primary is
	// executed in this operation, asynchronously from the promote replica
	// operation executed to the replica.
	//   "CLUSTER_MAINTENANCE" - Indicates that the instance, its read replicas,
	// and its cascading replicas are in maintenance. Maintenance typically gets
	// initiated on groups of replicas first, followed by the primary instance. For
	// each instance, maintenance typically causes the instance to be unavailable
	// for 1-3 minutes.
	//   "SELF_SERVICE_MAINTENANCE" - Indicates that the instance (and any of its
	// replicas) are currently in maintenance. This is initiated as a self-service
	// request by using SSM. Maintenance typically causes the instance to be
	// unavailable for 1-3 minutes.
	//   "SWITCHOVER_TO_REPLICA" - Switches a primary instance to a replica. This
	// operation runs as part of a switchover operation to the original primary
	// instance.
	OperationType string `json:"operationType,omitempty"`
	// SelfLink: The URI of this resource.
	SelfLink string `json:"selfLink,omitempty"`
	// StartTime: 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`.
	StartTime string `json:"startTime,omitempty"`
	// Status: The status of an operation.
	//
	// Possible values:
	//   "SQL_OPERATION_STATUS_UNSPECIFIED" - The state of the operation is
	// unknown.
	//   "PENDING" - The operation has been queued, but has not started yet.
	//   "RUNNING" - The operation is running.
	//   "DONE" - The operation completed.
	Status string `json:"status,omitempty"`
	// TargetId: Name of the database instance related to this operation.
	TargetId   string `json:"targetId,omitempty"`
	TargetLink string `json:"targetLink,omitempty"`
	// TargetProject: The project ID of the target instance related to this
	// operation.
	TargetProject string `json:"targetProject,omitempty"`
	// User: The email address of the user who initiated this operation.
	User string `json:"user,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AcquireSsrsLeaseContext") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AcquireSsrsLeaseContext") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Operation: An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

func (*Operation) MarshalJSON 

func (s *Operation) MarshalJSON() ([]byte, error)

type OperationError 

type OperationError struct {
	// Code: Identifies the specific error that occurred.
	Code string `json:"code,omitempty"`
	// Kind: This is always `sql#operationError`.
	Kind string `json:"kind,omitempty"`
	// Message: Additional information about the error encountered.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OperationError: Database instance operation error.

func (*OperationError) MarshalJSON 

func (s *OperationError) MarshalJSON() ([]byte, error)

type OperationErrors 

type OperationErrors struct {
	// Errors: The list of errors encountered while processing this operation.
	Errors []*OperationError `json:"errors,omitempty"`
	// Kind: This is always `sql#operationErrors`.
	Kind string `json:"kind,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Errors") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Errors") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OperationErrors: Database instance operation errors list wrapper.

func (*OperationErrors) MarshalJSON 

func (s *OperationErrors) MarshalJSON() ([]byte, error)

type OperationMetadata added in v0.112.0 

type OperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`
	// CancelRequested: Output only. Identifies whether the user has requested
	// cancellation of the operation. Operations that have been cancelled
	// successfully have Operation.error value with a google.rpc.Status.code of 1,
	// corresponding to `Code.CANCELLED`.
	CancelRequested bool `json:"cancelRequested,omitempty"`
	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// StatusDetail: Output only. Human-readable status of the operation, if any.
	StatusDetail string `json:"statusDetail,omitempty"`
	// Target: Output only. Server-defined resource path for the target of the
	// operation.
	Target string `json:"target,omitempty"`
	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `json:"verb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApiVersion") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OperationMetadata: Represents the metadata of the long-running operation.

func (*OperationMetadata) MarshalJSON added in v0.112.0 

func (s *OperationMetadata) MarshalJSON() ([]byte, error)

type OperationsCancelCall added in v0.126.0 

type OperationsCancelCall struct {
	// contains filtered or unexported fields
}

func (*OperationsCancelCall) Context added in v0.126.0 

func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall

Context sets the context to be used in this call's Do method.

func (*OperationsCancelCall) Do added in v0.126.0 

func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "sql.operations.cancel" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsCancelCall) Fields added in v0.126.0 

func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OperationsCancelCall) Header added in v0.126.0 

func (c *OperationsCancelCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OperationsGetCall 

type OperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*OperationsGetCall) Context 

func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall

Context sets the context to be used in this call's Do method.

func (*OperationsGetCall) Do 

func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsGetCall) Fields 

func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OperationsGetCall) Header 

func (c *OperationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OperationsGetCall) IfNoneMatch 

func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type OperationsListCall 

type OperationsListCall struct {
	// contains filtered or unexported fields
}

func (*OperationsListCall) Context 

func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall

Context sets the context to be used in this call's Do method.

func (*OperationsListCall) Do 

func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*OperationsListResponse, error)

Do executes the "sql.operations.list" call. Any non-2xx status code is an error. Response headers are in either *OperationsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsListCall) Fields 

func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OperationsListCall) Header 

func (c *OperationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OperationsListCall) IfNoneMatch 

func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OperationsListCall) Instance added in v0.14.0 

func (c *OperationsListCall) Instance(instance string) *OperationsListCall

Instance sets the optional parameter "instance": Cloud SQL instance ID. This does not include the project ID.

func (*OperationsListCall) MaxResults 

func (c *OperationsListCall) MaxResults(maxResults int64) *OperationsListCall

MaxResults sets the optional parameter "maxResults": Maximum number of operations per response.

func (*OperationsListCall) PageToken 

func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall

PageToken sets the optional parameter "pageToken": A previously-returned page token representing part of the larger set of results to view.

func (*OperationsListCall) Pages 

func (c *OperationsListCall) Pages(ctx context.Context, f func(*OperationsListResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OperationsListResponse 

type OperationsListResponse struct {
	// Items: List of operation resources.
	Items []*Operation `json:"items,omitempty"`
	// Kind: This is always `sql#operationsList`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: The continuation token, used to page through large result
	// sets. Provide this value in a subsequent request to return the next page of
	// results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Items") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OperationsListResponse: Operations list response.

func (*OperationsListResponse) MarshalJSON 

func (s *OperationsListResponse) MarshalJSON() ([]byte, error)

type OperationsService 

type OperationsService struct {
	// contains filtered or unexported fields
}

func NewOperationsService 

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService) Cancel added in v0.126.0 

func (r *OperationsService) Cancel(project string, operation string) *OperationsCancelCall

Cancel: Cancels an instance operation that has been performed on an instance.

- operation: Instance operation ID. - project: Project ID of the project that contains the instance.

func (*OperationsService) Get 

func (r *OperationsService) Get(project string, operation string) *OperationsGetCall

Get: Retrieves an instance operation that has been performed on an instance.

- operation: Instance operation ID. - project: Project ID of the project that contains the instance.

func (*OperationsService) List 

func (r *OperationsService) List(project string) *OperationsListCall

List: Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time.

- project: Project ID of the project that contains the instance.

type PasswordStatus added in v0.61.0 

type PasswordStatus struct {
	// Locked: If true, user does not have login privileges.
	Locked bool `json:"locked,omitempty"`
	// PasswordExpirationTime: The expiration time of the current password.
	PasswordExpirationTime string `json:"passwordExpirationTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Locked") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Locked") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PasswordStatus: Read-only password status.

func (*PasswordStatus) MarshalJSON added in v0.61.0 

func (s *PasswordStatus) MarshalJSON() ([]byte, error)

type PasswordValidationPolicy added in v0.61.0 

type PasswordValidationPolicy struct {
	// Complexity: The complexity of the password.
	//
	// Possible values:
	//   "COMPLEXITY_UNSPECIFIED" - Complexity check is not specified.
	//   "COMPLEXITY_DEFAULT" - A combination of lowercase, uppercase, numeric, and
	// non-alphanumeric characters.
	Complexity string `json:"complexity,omitempty"`
	// DisallowCompromisedCredentials: This field is deprecated and will be removed
	// in a future version of the API.
	DisallowCompromisedCredentials bool `json:"disallowCompromisedCredentials,omitempty"`
	// DisallowUsernameSubstring: Disallow username as a part of the password.
	DisallowUsernameSubstring bool `json:"disallowUsernameSubstring,omitempty"`
	// EnablePasswordPolicy: Whether the password policy is enabled or not.
	EnablePasswordPolicy bool `json:"enablePasswordPolicy,omitempty"`
	// MinLength: Minimum number of characters allowed.
	MinLength int64 `json:"minLength,omitempty"`
	// PasswordChangeInterval: Minimum interval after which the password can be
	// changed. This flag is only supported for PostgreSQL.
	PasswordChangeInterval string `json:"passwordChangeInterval,omitempty"`
	// ReuseInterval: Number of previous passwords that cannot be reused.
	ReuseInterval int64 `json:"reuseInterval,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Complexity") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Complexity") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PasswordValidationPolicy: Database instance local user password validation policy

func (*PasswordValidationPolicy) MarshalJSON added in v0.61.0 

func (s *PasswordValidationPolicy) MarshalJSON() ([]byte, error)

type PerformDiskShrinkContext added in v0.114.0 

type PerformDiskShrinkContext struct {
	// TargetSizeGb: The target disk shrink size in GigaBytes.
	TargetSizeGb int64 `json:"targetSizeGb,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "TargetSizeGb") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "TargetSizeGb") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PerformDiskShrinkContext: Perform disk shrink context.

func (*PerformDiskShrinkContext) MarshalJSON added in v0.114.0 

func (s *PerformDiskShrinkContext) MarshalJSON() ([]byte, error)

type ProjectsInstancesGetDiskShrinkConfigCall added in v0.114.0 

type ProjectsInstancesGetDiskShrinkConfigCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesGetDiskShrinkConfigCall) Context added in v0.114.0 

func (c *ProjectsInstancesGetDiskShrinkConfigCall) Context(ctx context.Context) *ProjectsInstancesGetDiskShrinkConfigCall

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesGetDiskShrinkConfigCall) Do added in v0.114.0 

func (c *ProjectsInstancesGetDiskShrinkConfigCall) Do(opts ...googleapi.CallOption) (*SqlInstancesGetDiskShrinkConfigResponse, error)

Do executes the "sql.projects.instances.getDiskShrinkConfig" call. Any non-2xx status code is an error. Response headers are in either *SqlInstancesGetDiskShrinkConfigResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesGetDiskShrinkConfigCall) Fields added in v0.114.0 

func (c *ProjectsInstancesGetDiskShrinkConfigCall) Fields(s ...googleapi.Field) *ProjectsInstancesGetDiskShrinkConfigCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesGetDiskShrinkConfigCall) Header added in v0.114.0 

func (c *ProjectsInstancesGetDiskShrinkConfigCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesGetDiskShrinkConfigCall) IfNoneMatch added in v0.114.0 

func (c *ProjectsInstancesGetDiskShrinkConfigCall) IfNoneMatch(entityTag string) *ProjectsInstancesGetDiskShrinkConfigCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsInstancesGetLatestRecoveryTimeCall added in v0.130.0 

type ProjectsInstancesGetLatestRecoveryTimeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesGetLatestRecoveryTimeCall) Context added in v0.130.0 

func (c *ProjectsInstancesGetLatestRecoveryTimeCall) Context(ctx context.Context) *ProjectsInstancesGetLatestRecoveryTimeCall

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesGetLatestRecoveryTimeCall) Do added in v0.130.0 

func (c *ProjectsInstancesGetLatestRecoveryTimeCall) Do(opts ...googleapi.CallOption) (*SqlInstancesGetLatestRecoveryTimeResponse, error)

Do executes the "sql.projects.instances.getLatestRecoveryTime" call. Any non-2xx status code is an error. Response headers are in either *SqlInstancesGetLatestRecoveryTimeResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesGetLatestRecoveryTimeCall) Fields added in v0.130.0 

func (c *ProjectsInstancesGetLatestRecoveryTimeCall) Fields(s ...googleapi.Field) *ProjectsInstancesGetLatestRecoveryTimeCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesGetLatestRecoveryTimeCall) Header added in v0.130.0 

func (c *ProjectsInstancesGetLatestRecoveryTimeCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesGetLatestRecoveryTimeCall) IfNoneMatch added in v0.130.0 

func (c *ProjectsInstancesGetLatestRecoveryTimeCall) IfNoneMatch(entityTag string) *ProjectsInstancesGetLatestRecoveryTimeCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsInstancesPerformDiskShrinkCall added in v0.114.0 

type ProjectsInstancesPerformDiskShrinkCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesPerformDiskShrinkCall) Context added in v0.114.0 

func (c *ProjectsInstancesPerformDiskShrinkCall) Context(ctx context.Context) *ProjectsInstancesPerformDiskShrinkCall

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesPerformDiskShrinkCall) Do added in v0.114.0 

func (c *ProjectsInstancesPerformDiskShrinkCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.projects.instances.performDiskShrink" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesPerformDiskShrinkCall) Fields added in v0.114.0 

func (c *ProjectsInstancesPerformDiskShrinkCall) Fields(s ...googleapi.Field) *ProjectsInstancesPerformDiskShrinkCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesPerformDiskShrinkCall) Header added in v0.114.0 

func (c *ProjectsInstancesPerformDiskShrinkCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesRescheduleMaintenanceCall added in v0.15.0 

type ProjectsInstancesRescheduleMaintenanceCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesRescheduleMaintenanceCall) Context added in v0.15.0 

func (c *ProjectsInstancesRescheduleMaintenanceCall) Context(ctx context.Context) *ProjectsInstancesRescheduleMaintenanceCall

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesRescheduleMaintenanceCall) Do added in v0.15.0 

func (c *ProjectsInstancesRescheduleMaintenanceCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.projects.instances.rescheduleMaintenance" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesRescheduleMaintenanceCall) Fields added in v0.15.0 

func (c *ProjectsInstancesRescheduleMaintenanceCall) Fields(s ...googleapi.Field) *ProjectsInstancesRescheduleMaintenanceCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesRescheduleMaintenanceCall) Header added in v0.15.0 

func (c *ProjectsInstancesRescheduleMaintenanceCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesResetReplicaSizeCall added in v0.114.0 

type ProjectsInstancesResetReplicaSizeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesResetReplicaSizeCall) Context added in v0.114.0 

func (c *ProjectsInstancesResetReplicaSizeCall) Context(ctx context.Context) *ProjectsInstancesResetReplicaSizeCall

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesResetReplicaSizeCall) Do added in v0.114.0 

func (c *ProjectsInstancesResetReplicaSizeCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.projects.instances.resetReplicaSize" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesResetReplicaSizeCall) Fields added in v0.114.0 

func (c *ProjectsInstancesResetReplicaSizeCall) Fields(s ...googleapi.Field) *ProjectsInstancesResetReplicaSizeCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesResetReplicaSizeCall) Header added in v0.114.0 

func (c *ProjectsInstancesResetReplicaSizeCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesService added in v0.15.0 

type ProjectsInstancesService struct {
	// contains filtered or unexported fields
}

func NewProjectsInstancesService added in v0.15.0 

func NewProjectsInstancesService(s *Service) *ProjectsInstancesService

func (*ProjectsInstancesService) GetDiskShrinkConfig added in v0.114.0 

func (r *ProjectsInstancesService) GetDiskShrinkConfig(project string, instance string) *ProjectsInstancesGetDiskShrinkConfigCall

GetDiskShrinkConfig: Get Disk Shrink Config for a given instance.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*ProjectsInstancesService) GetLatestRecoveryTime added in v0.130.0 

func (r *ProjectsInstancesService) GetLatestRecoveryTime(project string, instance string) *ProjectsInstancesGetLatestRecoveryTimeCall

GetLatestRecoveryTime: Get Latest Recovery Time for a given instance.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*ProjectsInstancesService) PerformDiskShrink added in v0.114.0 

func (r *ProjectsInstancesService) PerformDiskShrink(project string, instance string, performdiskshrinkcontext *PerformDiskShrinkContext) *ProjectsInstancesPerformDiskShrinkCall

PerformDiskShrink: Perform Disk Shrink on primary instance.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*ProjectsInstancesService) RescheduleMaintenance added in v0.15.0 

func (r *ProjectsInstancesService) RescheduleMaintenance(project string, instance string, sqlinstancesreschedulemaintenancerequestbody *SqlInstancesRescheduleMaintenanceRequestBody) *ProjectsInstancesRescheduleMaintenanceCall

RescheduleMaintenance: Reschedules the maintenance on the given instance.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: ID of the project that contains the instance.

func (*ProjectsInstancesService) ResetReplicaSize added in v0.114.0 

func (r *ProjectsInstancesService) ResetReplicaSize(project string, instance string, sqlinstancesresetreplicasizerequest *SqlInstancesResetReplicaSizeRequest) *ProjectsInstancesResetReplicaSizeCall

ResetReplicaSize: Reset Replica Size to primary instance disk size.

- instance: Cloud SQL read replica instance name. - project: ID of the project that contains the read replica.

func (*ProjectsInstancesService) StartExternalSync added in v0.18.0 

func (r *ProjectsInstancesService) StartExternalSync(project string, instance string, sqlinstancesstartexternalsyncrequest *SqlInstancesStartExternalSyncRequest) *ProjectsInstancesStartExternalSyncCall

StartExternalSync: Start External primary instance migration.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: ID of the project that contains the instance.

func (*ProjectsInstancesService) VerifyExternalSyncSettings added in v0.18.0 

func (r *ProjectsInstancesService) VerifyExternalSyncSettings(project string, instance string, sqlinstancesverifyexternalsyncsettingsrequest *SqlInstancesVerifyExternalSyncSettingsRequest) *ProjectsInstancesVerifyExternalSyncSettingsCall

VerifyExternalSyncSettings: Verify External primary instance external sync settings.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

type ProjectsInstancesStartExternalSyncCall added in v0.18.0 

type ProjectsInstancesStartExternalSyncCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesStartExternalSyncCall) Context added in v0.18.0 

func (c *ProjectsInstancesStartExternalSyncCall) Context(ctx context.Context) *ProjectsInstancesStartExternalSyncCall

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesStartExternalSyncCall) Do added in v0.18.0 

func (c *ProjectsInstancesStartExternalSyncCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.projects.instances.startExternalSync" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesStartExternalSyncCall) Fields added in v0.18.0 

func (c *ProjectsInstancesStartExternalSyncCall) Fields(s ...googleapi.Field) *ProjectsInstancesStartExternalSyncCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesStartExternalSyncCall) Header added in v0.18.0 

func (c *ProjectsInstancesStartExternalSyncCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesVerifyExternalSyncSettingsCall added in v0.18.0 

type ProjectsInstancesVerifyExternalSyncSettingsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesVerifyExternalSyncSettingsCall) Context added in v0.18.0 

func (c *ProjectsInstancesVerifyExternalSyncSettingsCall) Context(ctx context.Context) *ProjectsInstancesVerifyExternalSyncSettingsCall

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesVerifyExternalSyncSettingsCall) Do added in v0.18.0 

func (c *ProjectsInstancesVerifyExternalSyncSettingsCall) Do(opts ...googleapi.CallOption) (*SqlInstancesVerifyExternalSyncSettingsResponse, error)

Do executes the "sql.projects.instances.verifyExternalSyncSettings" call. Any non-2xx status code is an error. Response headers are in either *SqlInstancesVerifyExternalSyncSettingsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesVerifyExternalSyncSettingsCall) Fields added in v0.18.0 

func (c *ProjectsInstancesVerifyExternalSyncSettingsCall) Fields(s ...googleapi.Field) *ProjectsInstancesVerifyExternalSyncSettingsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesVerifyExternalSyncSettingsCall) Header added in v0.18.0 

func (c *ProjectsInstancesVerifyExternalSyncSettingsCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsService added in v0.15.0 

type ProjectsService struct {
	Instances *ProjectsInstancesService
	// contains filtered or unexported fields
}

func NewProjectsService added in v0.15.0 

func NewProjectsService(s *Service) *ProjectsService

type PscConfig added in v0.135.0 

type PscConfig struct {
	// AllowedConsumerProjects: Optional. The list of consumer projects that are
	// allow-listed for PSC connections to this instance. This instance can be
	// connected to with PSC from any network in these projects. Each consumer
	// project in this list may be represented by a project number (numeric) or by
	// a project id (alphanumeric).
	AllowedConsumerProjects []string `json:"allowedConsumerProjects,omitempty"`
	// PscEnabled: Whether PSC connectivity is enabled for this instance.
	PscEnabled bool `json:"pscEnabled,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedConsumerProjects") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowedConsumerProjects") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PscConfig: PSC settings for a Cloud SQL instance.

func (*PscConfig) MarshalJSON added in v0.135.0 

func (s *PscConfig) MarshalJSON() ([]byte, error)

type ReplicaConfiguration 

type ReplicaConfiguration struct {
	// CascadableReplica: Optional. Specifies if a SQL Server replica is a
	// cascadable replica. A cascadable replica is a SQL Server cross region
	// replica that supports replica(s) under it.
	CascadableReplica bool `json:"cascadableReplica,omitempty"`
	// FailoverTarget: 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 primary instance fails, the replica instance will be promoted as
	// the new primary instance. Only one replica can be specified as failover
	// target, and the replica has to be in different zone with the primary
	// instance.
	FailoverTarget bool `json:"failoverTarget,omitempty"`
	// Kind: This is always `sql#replicaConfiguration`.
	Kind string `json:"kind,omitempty"`
	// MysqlReplicaConfiguration: MySQL specific configuration when replicating
	// from a MySQL on-premises primary instance. 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.
	MysqlReplicaConfiguration *MySqlReplicaConfiguration `json:"mysqlReplicaConfiguration,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CascadableReplica") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CascadableReplica") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ReplicaConfiguration: Read-replica configuration for connecting to the primary instance.

func (*ReplicaConfiguration) MarshalJSON 

func (s *ReplicaConfiguration) MarshalJSON() ([]byte, error)

type ReplicationCluster added in v0.172.0 

type ReplicationCluster struct {
	// DrReplica: Output only. Read-only field that indicates whether the replica
	// is a DR replica. This field is not set if the instance is a primary
	// instance.
	DrReplica bool `json:"drReplica,omitempty"`
	// FailoverDrReplicaName: Optional. If the instance is a primary instance, then
	// this field identifies the disaster recovery (DR) replica. A DR replica is an
	// optional configuration for Enterprise Plus edition instances. If the
	// instance is a read replica, then the field is not set. Set this field to a
	// replica name to designate a DR replica for a primary instance. Remove the
	// replica name to remove the DR replica designation.
	FailoverDrReplicaName string `json:"failoverDrReplicaName,omitempty"`
	// PsaWriteEndpoint: Output only. If set, it indicates this instance has a
	// private service access (PSA) dns endpoint that is pointing to the primary
	// instance of the cluster. If this instance is the primary, the dns should be
	// pointing to this instance. After Switchover or Replica failover, this DNS
	// endpoint points to the promoted instance. This is a read-only field,
	// returned to the user as information. This field can exist even if a
	// standalone instance does not yet have a replica, or had a DR replica that
	// was deleted.
	PsaWriteEndpoint string `json:"psaWriteEndpoint,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DrReplica") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DrReplica") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ReplicationCluster: A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure. Only applicable to MySQL.

func (*ReplicationCluster) MarshalJSON added in v0.172.0 

func (s *ReplicationCluster) MarshalJSON() ([]byte, error)

type Reschedule added in v0.15.0 

type Reschedule struct {
	// RescheduleType: Required. The type of the reschedule.
	//
	// Possible values:
	//   "RESCHEDULE_TYPE_UNSPECIFIED"
	//   "IMMEDIATE" - Reschedules maintenance to happen now (within 5 minutes).
	//   "NEXT_AVAILABLE_WINDOW" - Reschedules maintenance to occur within one week
	// from the originally scheduled day and time.
	//   "SPECIFIC_TIME" - Reschedules maintenance to a specific time and day.
	RescheduleType string `json:"rescheduleType,omitempty"`
	// ScheduleTime: Optional. Timestamp when the maintenance shall be rescheduled
	// to if reschedule_type=SPECIFIC_TIME, in RFC 3339
	// (https://tools.ietf.org/html/rfc3339) format, for example
	// `2012-11-15T16:19:00.094Z`.
	ScheduleTime string `json:"scheduleTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RescheduleType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "RescheduleType") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*Reschedule) MarshalJSON added in v0.15.0 

func (s *Reschedule) MarshalJSON() ([]byte, error)

type RestoreBackupContext 

type RestoreBackupContext struct {
	// BackupRunId: The ID of the backup run to restore from.
	BackupRunId int64 `json:"backupRunId,omitempty,string"`
	// InstanceId: The ID of the instance that the backup was taken from.
	InstanceId string `json:"instanceId,omitempty"`
	// Kind: This is always `sql#restoreBackupContext`.
	Kind string `json:"kind,omitempty"`
	// Project: The full project ID of the source instance.
	Project string `json:"project,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BackupRunId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackupRunId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestoreBackupContext: Database instance restore from backup context. Backup context contains source instance id and project id.

func (*RestoreBackupContext) MarshalJSON 

func (s *RestoreBackupContext) MarshalJSON() ([]byte, error)

type RotateServerCaContext 

type RotateServerCaContext struct {
	// Kind: This is always `sql#rotateServerCaContext`.
	Kind string `json:"kind,omitempty"`
	// NextVersion: The fingerprint of the next version to be rotated to. If left
	// unspecified, will be rotated to the most recently added server CA version.
	NextVersion string `json:"nextVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Kind") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RotateServerCaContext: Instance rotate server CA context.

func (*RotateServerCaContext) MarshalJSON 

func (s *RotateServerCaContext) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	BackupRuns *BackupRunsService

	Connect *ConnectService

	Databases *DatabasesService

	Flags *FlagsService

	Instances *InstancesService

	Operations *OperationsService

	Projects *ProjectsService

	SslCerts *SslCertsService

	Tiers *TiersService

	Users *UsersService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Settings 

type Settings struct {
	// ActivationPolicy: The activation policy specifies when the instance is
	// activated; it is applicable only when the instance state is RUNNABLE. Valid
	// values: * `ALWAYS`: The instance is on, and remains so even in the absence
	// of connection requests. * `NEVER`: The instance is off; it is not activated,
	// even if a connection request arrives.
	//
	// Possible values:
	//   "SQL_ACTIVATION_POLICY_UNSPECIFIED" - Unknown activation plan.
	//   "ALWAYS" - The instance is always up and running.
	//   "NEVER" - The instance never starts.
	//   "ON_DEMAND" - The instance starts upon receiving requests.
	ActivationPolicy string `json:"activationPolicy,omitempty"`
	// ActiveDirectoryConfig: Active Directory configuration, relevant only for
	// Cloud SQL for SQL Server.
	ActiveDirectoryConfig *SqlActiveDirectoryConfig `json:"activeDirectoryConfig,omitempty"`
	// AdvancedMachineFeatures: Specifies advanced machine configuration for the
	// instances relevant only for SQL Server.
	AdvancedMachineFeatures *AdvancedMachineFeatures `json:"advancedMachineFeatures,omitempty"`
	// AuthorizedGaeApplications: The App Engine app IDs that can access this
	// instance. (Deprecated) Applied to First Generation instances only.
	AuthorizedGaeApplications []string `json:"authorizedGaeApplications,omitempty"`
	// AvailabilityType: Availability type. Potential values: * `ZONAL`: The
	// instance serves data from only one zone. Outages in that zone affect data
	// accessibility. * `REGIONAL`: The instance can serve data from more than one
	// zone in a region (it is highly available)./ For more information, see
	// Overview of the High Availability Configuration
	// (https://cloud.google.com/sql/docs/mysql/high-availability).
	//
	// Possible values:
	//   "SQL_AVAILABILITY_TYPE_UNSPECIFIED" - This is an unknown Availability
	// type.
	//   "ZONAL" - Zonal available instance.
	//   "REGIONAL" - Regional available instance.
	AvailabilityType string `json:"availabilityType,omitempty"`
	// BackupConfiguration: The daily backup configuration for the instance.
	BackupConfiguration *BackupConfiguration `json:"backupConfiguration,omitempty"`
	// Collation: The name of server Instance collation.
	Collation string `json:"collation,omitempty"`
	// ConnectorEnforcement: Specifies if connections must use Cloud SQL
	// connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL
	// instances can be connected without Cloud SQL Connectors) and `REQUIRED`
	// (Only allow connections that use Cloud SQL Connectors) Note that using
	// REQUIRED disables all existing authorized networks. If this field is not
	// specified when creating a new instance, NOT_REQUIRED is used. If this field
	// is not specified when patching or updating an existing instance, it is left
	// unchanged in the instance.
	//
	// Possible values:
	//   "CONNECTOR_ENFORCEMENT_UNSPECIFIED" - The requirement for Cloud SQL
	// connectors is unknown.
	//   "NOT_REQUIRED" - Do not require Cloud SQL connectors.
	//   "REQUIRED" - Require all connections to use Cloud SQL connectors,
	// including the Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go
	// connectors. Note: This disables all existing authorized networks.
	ConnectorEnforcement string `json:"connectorEnforcement,omitempty"`
	// CrashSafeReplicationEnabled: Configuration specific to read replica
	// instances. Indicates whether database flags for crash-safe replication are
	// enabled. This property was only applicable to First Generation instances.
	CrashSafeReplicationEnabled bool `json:"crashSafeReplicationEnabled,omitempty"`
	// DataCacheConfig: Configuration for data cache.
	DataCacheConfig *DataCacheConfig `json:"dataCacheConfig,omitempty"`
	// DataDiskSizeGb: The size of data disk, in GB. The data disk size minimum is
	// 10GB.
	DataDiskSizeGb int64 `json:"dataDiskSizeGb,omitempty,string"`
	// DataDiskType: The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not
	// used for First Generation instances.
	//
	// Possible values:
	//   "SQL_DATA_DISK_TYPE_UNSPECIFIED" - This is an unknown data disk type.
	//   "PD_SSD" - An SSD data disk.
	//   "PD_HDD" - An HDD data disk.
	//   "OBSOLETE_LOCAL_SSD" - This field is deprecated and will be removed from a
	// future version of the API.
	DataDiskType string `json:"dataDiskType,omitempty"`
	// DatabaseFlags: The database flags passed to the instance at startup.
	DatabaseFlags []*DatabaseFlags `json:"databaseFlags,omitempty"`
	// DatabaseReplicationEnabled: Configuration specific to read replica
	// instances. Indicates whether replication is enabled or not. WARNING:
	// Changing this restarts the instance.
	DatabaseReplicationEnabled bool `json:"databaseReplicationEnabled,omitempty"`
	// DeletionProtectionEnabled: Configuration to protect against accidental
	// instance deletion.
	DeletionProtectionEnabled bool `json:"deletionProtectionEnabled,omitempty"`
	// DenyMaintenancePeriods: Deny maintenance periods
	DenyMaintenancePeriods []*DenyMaintenancePeriod `json:"denyMaintenancePeriods,omitempty"`
	// Edition: Optional. The edition of the instance.
	//
	// Possible values:
	//   "EDITION_UNSPECIFIED" - The instance did not specify the edition.
	//   "ENTERPRISE" - The instance is an enterprise edition.
	//   "ENTERPRISE_PLUS" - The instance is an Enterprise Plus edition.
	Edition string `json:"edition,omitempty"`
	// EnableGoogleMlIntegration: Optional. When this parameter is set to true,
	// Cloud SQL instances can connect to Vertex AI to pass requests for real-time
	// predictions and insights to the AI. The default value is false. This applies
	// only to Cloud SQL for PostgreSQL instances.
	EnableGoogleMlIntegration bool `json:"enableGoogleMlIntegration,omitempty"`
	// InsightsConfig: Insights configuration, for now relevant only for Postgres.
	InsightsConfig *InsightsConfig `json:"insightsConfig,omitempty"`
	// IpConfiguration: The settings for IP Management. This allows to enable or
	// disable the instance IP and manage which external networks can connect to
	// the instance. The IPv4 address cannot be disabled for Second Generation
	// instances.
	IpConfiguration *IpConfiguration `json:"ipConfiguration,omitempty"`
	// Kind: This is always `sql#settings`.
	Kind string `json:"kind,omitempty"`
	// LocationPreference: The location preference settings. This allows the
	// instance to be located as near as possible to either an App Engine app or
	// Compute Engine zone for better performance. App Engine co-location was only
	// applicable to First Generation instances.
	LocationPreference *LocationPreference `json:"locationPreference,omitempty"`
	// MaintenanceWindow: The maintenance window for this instance. This specifies
	// when the instance can be restarted for maintenance purposes.
	MaintenanceWindow *MaintenanceWindow `json:"maintenanceWindow,omitempty"`
	// PasswordValidationPolicy: The local user password validation policy of the
	// instance.
	PasswordValidationPolicy *PasswordValidationPolicy `json:"passwordValidationPolicy,omitempty"`
	// PricingPlan: The pricing plan for this instance. This can be either
	// `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation
	// instances.
	//
	// Possible values:
	//   "SQL_PRICING_PLAN_UNSPECIFIED" - This is an unknown pricing plan for this
	// instance.
	//   "PACKAGE" - The instance is billed at a monthly flat rate.
	//   "PER_USE" - The instance is billed per usage.
	PricingPlan string `json:"pricingPlan,omitempty"`
	// ReplicationType: The type of replication this instance uses. This can be
	// either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only
	// applicable to First Generation instances.
	//
	// Possible values:
	//   "SQL_REPLICATION_TYPE_UNSPECIFIED" - This is an unknown replication type
	// for a Cloud SQL instance.
	//   "SYNCHRONOUS" - The synchronous replication mode for First Generation
	// instances. It is the default value.
	//   "ASYNCHRONOUS" - The asynchronous replication mode for First Generation
	// instances. It provides a slight performance gain, but if an outage occurs
	// while this option is set to asynchronous, you can lose up to a few seconds
	// of updates to your data.
	ReplicationType string `json:"replicationType,omitempty"`
	// SettingsVersion: 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.
	SettingsVersion int64 `json:"settingsVersion,omitempty,string"`
	// SqlServerAuditConfig: SQL Server specific audit configuration.
	SqlServerAuditConfig *SqlServerAuditConfig `json:"sqlServerAuditConfig,omitempty"`
	// StorageAutoResize: Configuration to increase storage size automatically. The
	// default value is true.
	StorageAutoResize *bool `json:"storageAutoResize,omitempty"`
	// StorageAutoResizeLimit: The maximum size to which storage capacity can be
	// automatically increased. The default value is 0, which specifies that there
	// is no limit.
	StorageAutoResizeLimit int64 `json:"storageAutoResizeLimit,omitempty,string"`
	// Tier: The tier (or machine type) for this instance, for example
	// `db-custom-1-3840`. WARNING: Changing this restarts the instance.
	Tier string `json:"tier,omitempty"`
	// TimeZone: Server timezone, relevant only for Cloud SQL for SQL Server.
	TimeZone string `json:"timeZone,omitempty"`
	// UserLabels: User-provided labels, represented as a dictionary where each
	// label is a single key value pair.
	UserLabels map[string]string `json:"userLabels,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ActivationPolicy") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ActivationPolicy") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Settings: Database instance settings.

func (*Settings) MarshalJSON 

func (s *Settings) MarshalJSON() ([]byte, error)

type SqlActiveDirectoryConfig added in v0.33.0 

type SqlActiveDirectoryConfig struct {
	// Domain: The name of the domain (e.g., mydomain.com).
	Domain string `json:"domain,omitempty"`
	// Kind: This is always sql#activeDirectoryConfig.
	Kind string `json:"kind,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Domain") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Domain") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlActiveDirectoryConfig: Active Directory configuration, relevant only for Cloud SQL for SQL Server.

func (*SqlActiveDirectoryConfig) MarshalJSON added in v0.33.0 

func (s *SqlActiveDirectoryConfig) MarshalJSON() ([]byte, error)

type SqlExternalSyncSettingError added in v0.18.0 

type SqlExternalSyncSettingError struct {
	// Detail: Additional information about the error encountered.
	Detail string `json:"detail,omitempty"`
	// Kind: Can be `sql#externalSyncSettingError` or
	// `sql#externalSyncSettingWarning`.
	Kind string `json:"kind,omitempty"`
	// Type: Identifies the specific error that occurred.
	//
	// Possible values:
	//   "SQL_EXTERNAL_SYNC_SETTING_ERROR_TYPE_UNSPECIFIED"
	//   "CONNECTION_FAILURE"
	//   "BINLOG_NOT_ENABLED"
	//   "INCOMPATIBLE_DATABASE_VERSION"
	//   "REPLICA_ALREADY_SETUP"
	//   "INSUFFICIENT_PRIVILEGE" - The replication user is missing privileges that
	// are required.
	//   "UNSUPPORTED_MIGRATION_TYPE" - Unsupported migration type.
	//   "NO_PGLOGICAL_INSTALLED" - No pglogical extension installed on databases,
	// applicable for postgres.
	//   "PGLOGICAL_NODE_ALREADY_EXISTS" - pglogical node already exists on
	// databases, applicable for postgres.
	//   "INVALID_WAL_LEVEL" - The value of parameter wal_level is not set to
	// logical.
	//   "INVALID_SHARED_PRELOAD_LIBRARY" - The value of parameter
	// shared_preload_libraries does not include pglogical.
	//   "INSUFFICIENT_MAX_REPLICATION_SLOTS" - The value of parameter
	// max_replication_slots is not sufficient.
	//   "INSUFFICIENT_MAX_WAL_SENDERS" - The value of parameter max_wal_senders is
	// not sufficient.
	//   "INSUFFICIENT_MAX_WORKER_PROCESSES" - The value of parameter
	// max_worker_processes is not sufficient.
	//   "UNSUPPORTED_EXTENSIONS" - Extensions installed are either not supported
	// or having unsupported versions
	//   "INVALID_RDS_LOGICAL_REPLICATION" - The value of parameter
	// rds.logical_replication is not set to 1.
	//   "INVALID_LOGGING_SETUP" - The primary instance logging setup doesn't allow
	// EM sync.
	//   "INVALID_DB_PARAM" - The primary instance database parameter setup doesn't
	// allow EM sync.
	//   "UNSUPPORTED_GTID_MODE" - The gtid_mode is not supported, applicable for
	// MySQL.
	//   "SQLSERVER_AGENT_NOT_RUNNING" - SQL Server Agent is not running.
	//   "UNSUPPORTED_TABLE_DEFINITION" - The table definition is not support due
	// to missing primary key or replica identity, applicable for postgres.
	//   "UNSUPPORTED_DEFINER" - The customer has a definer that will break EM
	// setup.
	//   "SQLSERVER_SERVERNAME_MISMATCH" - SQL Server @@SERVERNAME does not match
	// actual host name.
	//   "PRIMARY_ALREADY_SETUP" - The primary instance has been setup and will
	// fail the setup.
	//   "UNSUPPORTED_BINLOG_FORMAT" - The primary instance has unsupported binary
	// log format.
	//   "BINLOG_RETENTION_SETTING" - The primary instance's binary log retention
	// setting.
	//   "UNSUPPORTED_STORAGE_ENGINE" - The primary instance has tables with
	// unsupported storage engine.
	//   "LIMITED_SUPPORT_TABLES" - Source has tables with limited support eg:
	// PostgreSQL tables without primary keys.
	//   "EXISTING_DATA_IN_REPLICA" - The replica instance contains existing data.
	//   "MISSING_OPTIONAL_PRIVILEGES" - The replication user is missing privileges
	// that are optional.
	//   "RISKY_BACKUP_ADMIN_PRIVILEGE" - Additional BACKUP_ADMIN privilege is
	// granted to the replication user which may lock source MySQL 8 instance for
	// DDLs during initial sync.
	//   "INSUFFICIENT_GCS_PERMISSIONS" - The Cloud Storage bucket is missing
	// necessary permissions.
	//   "INVALID_FILE_INFO" - The Cloud Storage bucket has an error in the file or
	// contains invalid file information.
	//   "UNSUPPORTED_DATABASE_SETTINGS" - The source instance has unsupported
	// database settings for migration.
	//   "MYSQL_PARALLEL_IMPORT_INSUFFICIENT_PRIVILEGE" - The replication user is
	// missing parallel import specific privileges. (e.g. LOCK TABLES) for MySQL.
	//   "LOCAL_INFILE_OFF" - The global variable local_infile is off on external
	// server replica.
	//   "TURN_ON_PITR_AFTER_PROMOTE" - This code instructs customers to turn on
	// point-in-time recovery manually for the instance after promoting the Cloud
	// SQL for PostgreSQL instance.
	//   "INCOMPATIBLE_DATABASE_MINOR_VERSION" - The minor version of replica
	// database is incompatible with the source.
	//   "SOURCE_MAX_SUBSCRIPTIONS" - This warning message indicates that Cloud SQL
	// uses the maximum number of subscriptions to migrate data from the source to
	// the destination.
	//   "UNABLE_TO_VERIFY_DEFINERS" - Unable to verify definers on the source for
	// MySQL.
	//   "SUBSCRIPTION_CALCULATION_STATUS" - If a time out occurs while the
	// subscription counts are calculated, then this value is set to 1. Otherwise,
	// this value is set to 2.
	//   "PG_SUBSCRIPTION_COUNT" - Count of subscriptions needed to sync source
	// data for PostgreSQL database.
	//   "PG_SYNC_PARALLEL_LEVEL" - Final parallel level that is used to do
	// migration.
	//   "INSUFFICIENT_DISK_SIZE" - The disk size of the replica instance is
	// smaller than the data size of the source instance.
	//   "INSUFFICIENT_MACHINE_TIER" - The data size of the source instance is
	// greater than 1 TB, the number of cores of the replica instance is less than
	// 8, and the memory of the replica is less than 32 GB.
	//   "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED" - The warning message indicates the
	// unsupported extensions will not be migrated to the destination.
	//   "EXTENSIONS_NOT_MIGRATED" - The warning message indicates the pg_cron
	// extension and settings will not be migrated to the destination.
	//   "PG_CRON_FLAG_ENABLED_IN_REPLICA" - The error message indicates that
	// pg_cron flags are enabled on the destination which is not supported during
	// the migration.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Detail") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Detail") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlExternalSyncSettingError: External primary instance migration setting error/warning.

func (*SqlExternalSyncSettingError) MarshalJSON added in v0.18.0 

func (s *SqlExternalSyncSettingError) MarshalJSON() ([]byte, error)

type SqlInstancesAcquireSsrsLeaseResponse added in v0.170.0 

type SqlInstancesAcquireSsrsLeaseResponse struct {
	// OperationId: The unique identifier for this operation.
	OperationId string `json:"operationId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "OperationId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "OperationId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlInstancesAcquireSsrsLeaseResponse: Acquire SSRS lease response.

func (*SqlInstancesAcquireSsrsLeaseResponse) MarshalJSON added in v0.170.0 

func (s *SqlInstancesAcquireSsrsLeaseResponse) MarshalJSON() ([]byte, error)

type SqlInstancesGetDiskShrinkConfigResponse added in v0.114.0 

type SqlInstancesGetDiskShrinkConfigResponse struct {
	// Kind: This is always `sql#getDiskShrinkConfig`.
	Kind string `json:"kind,omitempty"`
	// Message: Additional message to customers.
	Message string `json:"message,omitempty"`
	// MinimalTargetSizeGb: The minimum size to which a disk can be shrunk in
	// GigaBytes.
	MinimalTargetSizeGb int64 `json:"minimalTargetSizeGb,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Kind") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlInstancesGetDiskShrinkConfigResponse: Instance get disk shrink config response.

func (*SqlInstancesGetDiskShrinkConfigResponse) MarshalJSON added in v0.114.0 

func (s *SqlInstancesGetDiskShrinkConfigResponse) MarshalJSON() ([]byte, error)

type SqlInstancesGetLatestRecoveryTimeResponse added in v0.130.0 

type SqlInstancesGetLatestRecoveryTimeResponse struct {
	// Kind: This is always `sql#getLatestRecoveryTime`.
	Kind string `json:"kind,omitempty"`
	// LatestRecoveryTime: Timestamp, identifies the latest recovery time of the
	// source instance.
	LatestRecoveryTime string `json:"latestRecoveryTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Kind") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlInstancesGetLatestRecoveryTimeResponse: Instance get latest recovery time response.

func (*SqlInstancesGetLatestRecoveryTimeResponse) MarshalJSON added in v0.130.0 

func (s *SqlInstancesGetLatestRecoveryTimeResponse) MarshalJSON() ([]byte, error)

type SqlInstancesReleaseSsrsLeaseResponse added in v0.170.0 

type SqlInstancesReleaseSsrsLeaseResponse struct {
	// OperationId: The operation ID.
	OperationId string `json:"operationId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "OperationId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "OperationId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlInstancesReleaseSsrsLeaseResponse: The response for the release of the SSRS lease.

func (*SqlInstancesReleaseSsrsLeaseResponse) MarshalJSON added in v0.170.0 

func (s *SqlInstancesReleaseSsrsLeaseResponse) MarshalJSON() ([]byte, error)

type SqlInstancesRescheduleMaintenanceRequestBody added in v0.15.0 

type SqlInstancesRescheduleMaintenanceRequestBody struct {
	// Reschedule: Required. The type of the reschedule the user wants.
	Reschedule *Reschedule `json:"reschedule,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Reschedule") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Reschedule") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlInstancesRescheduleMaintenanceRequestBody: Reschedule options for maintenance windows.

func (*SqlInstancesRescheduleMaintenanceRequestBody) MarshalJSON added in v0.15.0 

func (s *SqlInstancesRescheduleMaintenanceRequestBody) MarshalJSON() ([]byte, error)

type SqlInstancesResetReplicaSizeRequest added in v0.114.0 

type SqlInstancesResetReplicaSizeRequest struct {
}

SqlInstancesResetReplicaSizeRequest: Instance reset replica size request.

type SqlInstancesStartExternalSyncRequest added in v0.53.0 

type SqlInstancesStartExternalSyncRequest struct {
	// MigrationType: Optional. MigrationType configures the migration to use
	// physical files or logical dump files. If not set, then the logical dump file
	// configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only
	// applicable to MySQL.
	//
	// Possible values:
	//   "MIGRATION_TYPE_UNSPECIFIED" - Default value is a logical dump file-based
	// migration
	//   "LOGICAL" - Logical dump file-based migration
	//   "PHYSICAL" - Physical file-based migration
	MigrationType string `json:"migrationType,omitempty"`
	// MysqlSyncConfig: MySQL-specific settings for start external sync.
	MysqlSyncConfig *MySqlSyncConfig `json:"mysqlSyncConfig,omitempty"`
	// SkipVerification: Whether to skip the verification step (VESS).
	SkipVerification bool `json:"skipVerification,omitempty"`
	// SyncMode: External sync mode.
	//
	// Possible values:
	//   "EXTERNAL_SYNC_MODE_UNSPECIFIED" - Unknown external sync mode, will be
	// defaulted to ONLINE mode
	//   "ONLINE" - Online external sync will set up replication after initial data
	// external sync
	//   "OFFLINE" - Offline external sync only dumps and loads a one-time snapshot
	// of the primary instance's data
	SyncMode string `json:"syncMode,omitempty"`
	// SyncParallelLevel: Optional. Parallel level for initial data sync. Currently
	// only applicable for MySQL.
	//
	// Possible values:
	//   "EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED" - Unknown sync parallel level.
	// Will be defaulted to OPTIMAL.
	//   "MIN" - Minimal parallel level.
	//   "OPTIMAL" - Optimal parallel level.
	//   "MAX" - Maximum parallel level.
	SyncParallelLevel string `json:"syncParallelLevel,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MigrationType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MigrationType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*SqlInstancesStartExternalSyncRequest) MarshalJSON added in v0.53.0 

func (s *SqlInstancesStartExternalSyncRequest) MarshalJSON() ([]byte, error)

type SqlInstancesVerifyExternalSyncSettingsRequest added in v0.53.0 

type SqlInstancesVerifyExternalSyncSettingsRequest struct {
	// MigrationType: Optional. MigrationType configures the migration to use
	// physical files or logical dump files. If not set, then the logical dump file
	// configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only
	// applicable to MySQL.
	//
	// Possible values:
	//   "MIGRATION_TYPE_UNSPECIFIED" - Default value is a logical dump file-based
	// migration
	//   "LOGICAL" - Logical dump file-based migration
	//   "PHYSICAL" - Physical file-based migration
	MigrationType string `json:"migrationType,omitempty"`
	// MysqlSyncConfig: Optional. MySQL-specific settings for start external sync.
	MysqlSyncConfig *MySqlSyncConfig `json:"mysqlSyncConfig,omitempty"`
	// SyncMode: External sync mode
	//
	// Possible values:
	//   "EXTERNAL_SYNC_MODE_UNSPECIFIED" - Unknown external sync mode, will be
	// defaulted to ONLINE mode
	//   "ONLINE" - Online external sync will set up replication after initial data
	// external sync
	//   "OFFLINE" - Offline external sync only dumps and loads a one-time snapshot
	// of the primary instance's data
	SyncMode string `json:"syncMode,omitempty"`
	// SyncParallelLevel: Optional. Parallel level for initial data sync. Only
	// applicable for PostgreSQL.
	//
	// Possible values:
	//   "EXTERNAL_SYNC_PARALLEL_LEVEL_UNSPECIFIED" - Unknown sync parallel level.
	// Will be defaulted to OPTIMAL.
	//   "MIN" - Minimal parallel level.
	//   "OPTIMAL" - Optimal parallel level.
	//   "MAX" - Maximum parallel level.
	SyncParallelLevel string `json:"syncParallelLevel,omitempty"`
	// VerifyConnectionOnly: Flag to enable verifying connection only
	VerifyConnectionOnly bool `json:"verifyConnectionOnly,omitempty"`
	// VerifyReplicationOnly: Optional. Flag to verify settings required by
	// replication setup only
	VerifyReplicationOnly bool `json:"verifyReplicationOnly,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MigrationType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MigrationType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (*SqlInstancesVerifyExternalSyncSettingsRequest) MarshalJSON added in v0.53.0 

func (s *SqlInstancesVerifyExternalSyncSettingsRequest) MarshalJSON() ([]byte, error)

type SqlInstancesVerifyExternalSyncSettingsResponse added in v0.18.0 

type SqlInstancesVerifyExternalSyncSettingsResponse struct {
	// Errors: List of migration violations.
	Errors []*SqlExternalSyncSettingError `json:"errors,omitempty"`
	// Kind: This is always `sql#migrationSettingErrorList`.
	Kind string `json:"kind,omitempty"`
	// Warnings: List of migration warnings.
	Warnings []*SqlExternalSyncSettingError `json:"warnings,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Errors") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Errors") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlInstancesVerifyExternalSyncSettingsResponse: Instance verify external sync settings response.

func (*SqlInstancesVerifyExternalSyncSettingsResponse) MarshalJSON added in v0.18.0 

func (s *SqlInstancesVerifyExternalSyncSettingsResponse) MarshalJSON() ([]byte, error)

type SqlOutOfDiskReport added in v0.46.0 

type SqlOutOfDiskReport struct {
	// SqlMinRecommendedIncreaseSizeGb: The minimum recommended increase size in
	// GigaBytes This field is consumed by the frontend * Writers: * the proactive
	// database wellness job for OOD. * Readers:
	SqlMinRecommendedIncreaseSizeGb int64 `json:"sqlMinRecommendedIncreaseSizeGb,omitempty"`
	// SqlOutOfDiskState: This field represents the state generated by the
	// proactive database wellness job for OutOfDisk issues. * Writers: * the
	// proactive database wellness job for OOD. * Readers: * the proactive database
	// wellness job
	//
	// Possible values:
	//   "SQL_OUT_OF_DISK_STATE_UNSPECIFIED" - Unspecified state
	//   "NORMAL" - The instance has plenty space on data disk
	//   "SOFT_SHUTDOWN" - Data disk is almost used up. It is shutdown to prevent
	// data corruption.
	SqlOutOfDiskState string `json:"sqlOutOfDiskState,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "SqlMinRecommendedIncreaseSizeGb") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted from
	// API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "SqlMinRecommendedIncreaseSizeGb")
	// to include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlOutOfDiskReport: This message wraps up the information written by out-of-disk detection job.

func (*SqlOutOfDiskReport) MarshalJSON added in v0.46.0 

func (s *SqlOutOfDiskReport) MarshalJSON() ([]byte, error)

type SqlScheduledMaintenance added in v0.14.0 

type SqlScheduledMaintenance struct {
	CanDefer bool `json:"canDefer,omitempty"`
	// CanReschedule: If the scheduled maintenance can be rescheduled.
	CanReschedule bool `json:"canReschedule,omitempty"`
	// ScheduleDeadlineTime: Maintenance cannot be rescheduled to start beyond this
	// deadline.
	ScheduleDeadlineTime string `json:"scheduleDeadlineTime,omitempty"`
	// StartTime: The start time of any upcoming scheduled maintenance for this
	// instance.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CanDefer") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CanDefer") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlScheduledMaintenance: Any scheduled maintenance for this instance.

func (*SqlScheduledMaintenance) MarshalJSON added in v0.14.0 

func (s *SqlScheduledMaintenance) MarshalJSON() ([]byte, error)

type SqlServerAuditConfig added in v0.57.0 

type SqlServerAuditConfig struct {
	// Bucket: The name of the destination bucket (e.g., gs://mybucket).
	Bucket string `json:"bucket,omitempty"`
	// Kind: This is always sql#sqlServerAuditConfig
	Kind string `json:"kind,omitempty"`
	// RetentionInterval: How long to keep generated audit files.
	RetentionInterval string `json:"retentionInterval,omitempty"`
	// UploadInterval: How often to upload generated audit files.
	UploadInterval string `json:"uploadInterval,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Bucket") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Bucket") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlServerAuditConfig: SQL Server specific audit configuration.

func (*SqlServerAuditConfig) MarshalJSON added in v0.57.0 

func (s *SqlServerAuditConfig) MarshalJSON() ([]byte, error)

type SqlServerDatabaseDetails added in v0.14.0 

type SqlServerDatabaseDetails struct {
	// CompatibilityLevel: The version of SQL Server with which the database is to
	// be made compatible
	CompatibilityLevel int64 `json:"compatibilityLevel,omitempty"`
	// RecoveryModel: The recovery model of a SQL Server database
	RecoveryModel string `json:"recoveryModel,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CompatibilityLevel") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CompatibilityLevel") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlServerDatabaseDetails: Represents a Sql Server database on the Cloud SQL instance.

func (*SqlServerDatabaseDetails) MarshalJSON added in v0.14.0 

func (s *SqlServerDatabaseDetails) MarshalJSON() ([]byte, error)

type SqlServerUserDetails added in v0.16.0 

type SqlServerUserDetails struct {
	// Disabled: If the user has been disabled
	Disabled bool `json:"disabled,omitempty"`
	// ServerRoles: The server roles for this user
	ServerRoles []string `json:"serverRoles,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Disabled") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Disabled") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SqlServerUserDetails: Represents a Sql Server user on the Cloud SQL instance.

func (*SqlServerUserDetails) MarshalJSON added in v0.16.0 

func (s *SqlServerUserDetails) MarshalJSON() ([]byte, error)

type SslCert 

type SslCert struct {
	// Cert: PEM representation.
	Cert string `json:"cert,omitempty"`
	// CertSerialNumber: Serial number, as extracted from the certificate.
	CertSerialNumber string `json:"certSerialNumber,omitempty"`
	// CommonName: User supplied name. Constrained to [a-zA-Z.-_ ]+.
	CommonName string `json:"commonName,omitempty"`
	// CreateTime: The time when the certificate was created in RFC 3339
	// (https://tools.ietf.org/html/rfc3339) format, for example
	// `2012-11-15T16:19:00.094Z`.
	CreateTime string `json:"createTime,omitempty"`
	// ExpirationTime: The time when the certificate expires in RFC 3339
	// (https://tools.ietf.org/html/rfc3339) format, for example
	// `2012-11-15T16:19:00.094Z`.
	ExpirationTime string `json:"expirationTime,omitempty"`
	// Instance: Name of the database instance.
	Instance string `json:"instance,omitempty"`
	// Kind: This is always `sql#sslCert`.
	Kind string `json:"kind,omitempty"`
	// SelfLink: The URI of this resource.
	SelfLink string `json:"selfLink,omitempty"`
	// Sha1Fingerprint: Sha1 Fingerprint.
	Sha1Fingerprint string `json:"sha1Fingerprint,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Cert") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Cert") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SslCert: SslCerts Resource

func (*SslCert) MarshalJSON 

func (s *SslCert) MarshalJSON() ([]byte, error)

type SslCertDetail 

type SslCertDetail struct {
	// CertInfo: The public information about the cert.
	CertInfo *SslCert `json:"certInfo,omitempty"`
	// CertPrivateKey: The private key for the client cert, in pem format. Keep
	// private in order to protect your security.
	CertPrivateKey string `json:"certPrivateKey,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CertInfo") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CertInfo") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SslCertDetail: SslCertDetail.

func (*SslCertDetail) MarshalJSON 

func (s *SslCertDetail) MarshalJSON() ([]byte, error)

type SslCertsCreateEphemeralCall 

type SslCertsCreateEphemeralCall struct {
	// contains filtered or unexported fields
}

func (*SslCertsCreateEphemeralCall) Context 

func (c *SslCertsCreateEphemeralCall) Context(ctx context.Context) *SslCertsCreateEphemeralCall

Context sets the context to be used in this call's Do method.

func (*SslCertsCreateEphemeralCall) Do 

func (c *SslCertsCreateEphemeralCall) Do(opts ...googleapi.CallOption) (*SslCert, error)

Do executes the "sql.sslCerts.createEphemeral" call. Any non-2xx status code is an error. Response headers are in either *SslCert.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SslCertsCreateEphemeralCall) Fields 

func (c *SslCertsCreateEphemeralCall) Fields(s ...googleapi.Field) *SslCertsCreateEphemeralCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SslCertsCreateEphemeralCall) Header 

func (c *SslCertsCreateEphemeralCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type SslCertsCreateEphemeralRequest 

type SslCertsCreateEphemeralRequest struct {
	// AccessToken: Access token to include in the signed certificate.
	AccessToken string `json:"access_token,omitempty"`
	// PublicKey: PEM encoded public key to include in the signed certificate.
	PublicKey string `json:"public_key,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AccessToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AccessToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SslCertsCreateEphemeralRequest: SslCerts create ephemeral certificate request.

func (*SslCertsCreateEphemeralRequest) MarshalJSON 

func (s *SslCertsCreateEphemeralRequest) MarshalJSON() ([]byte, error)

type SslCertsDeleteCall 

type SslCertsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*SslCertsDeleteCall) Context 

func (c *SslCertsDeleteCall) Context(ctx context.Context) *SslCertsDeleteCall

Context sets the context to be used in this call's Do method.

func (*SslCertsDeleteCall) Do 

func (c *SslCertsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.sslCerts.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SslCertsDeleteCall) Fields 

func (c *SslCertsDeleteCall) Fields(s ...googleapi.Field) *SslCertsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SslCertsDeleteCall) Header 

func (c *SslCertsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type SslCertsGetCall 

type SslCertsGetCall struct {
	// contains filtered or unexported fields
}

func (*SslCertsGetCall) Context 

func (c *SslCertsGetCall) Context(ctx context.Context) *SslCertsGetCall

Context sets the context to be used in this call's Do method.

func (*SslCertsGetCall) Do 

func (c *SslCertsGetCall) Do(opts ...googleapi.CallOption) (*SslCert, error)

Do executes the "sql.sslCerts.get" call. Any non-2xx status code is an error. Response headers are in either *SslCert.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SslCertsGetCall) Fields 

func (c *SslCertsGetCall) Fields(s ...googleapi.Field) *SslCertsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SslCertsGetCall) Header 

func (c *SslCertsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*SslCertsGetCall) IfNoneMatch 

func (c *SslCertsGetCall) IfNoneMatch(entityTag string) *SslCertsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type SslCertsInsertCall 

type SslCertsInsertCall struct {
	// contains filtered or unexported fields
}

func (*SslCertsInsertCall) Context 

func (c *SslCertsInsertCall) Context(ctx context.Context) *SslCertsInsertCall

Context sets the context to be used in this call's Do method.

func (*SslCertsInsertCall) Do 

func (c *SslCertsInsertCall) Do(opts ...googleapi.CallOption) (*SslCertsInsertResponse, error)

Do executes the "sql.sslCerts.insert" call. Any non-2xx status code is an error. Response headers are in either *SslCertsInsertResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SslCertsInsertCall) Fields 

func (c *SslCertsInsertCall) Fields(s ...googleapi.Field) *SslCertsInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SslCertsInsertCall) Header 

func (c *SslCertsInsertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type SslCertsInsertRequest 

type SslCertsInsertRequest struct {
	// CommonName: User supplied name. Must be a distinct name from the other
	// certificates for this instance.
	CommonName string `json:"commonName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CommonName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CommonName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SslCertsInsertRequest: SslCerts insert request.

func (*SslCertsInsertRequest) MarshalJSON 

func (s *SslCertsInsertRequest) MarshalJSON() ([]byte, error)

type SslCertsInsertResponse 

type SslCertsInsertResponse struct {
	// ClientCert: The new client certificate and private key.
	ClientCert *SslCertDetail `json:"clientCert,omitempty"`
	// Kind: This is always `sql#sslCertsInsert`.
	Kind string `json:"kind,omitempty"`
	// Operation: The operation to track the ssl certs insert request.
	Operation *Operation `json:"operation,omitempty"`
	// ServerCaCert: 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.
	ServerCaCert *SslCert `json:"serverCaCert,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ClientCert") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ClientCert") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SslCertsInsertResponse: SslCert insert response.

func (*SslCertsInsertResponse) MarshalJSON 

func (s *SslCertsInsertResponse) MarshalJSON() ([]byte, error)

type SslCertsListCall 

type SslCertsListCall struct {
	// contains filtered or unexported fields
}

func (*SslCertsListCall) Context 

func (c *SslCertsListCall) Context(ctx context.Context) *SslCertsListCall

Context sets the context to be used in this call's Do method.

func (*SslCertsListCall) Do 

func (c *SslCertsListCall) Do(opts ...googleapi.CallOption) (*SslCertsListResponse, error)

Do executes the "sql.sslCerts.list" call. Any non-2xx status code is an error. Response headers are in either *SslCertsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SslCertsListCall) Fields 

func (c *SslCertsListCall) Fields(s ...googleapi.Field) *SslCertsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*SslCertsListCall) Header 

func (c *SslCertsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*SslCertsListCall) IfNoneMatch 

func (c *SslCertsListCall) IfNoneMatch(entityTag string) *SslCertsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type SslCertsListResponse 

type SslCertsListResponse struct {
	// Items: List of client certificates for the instance.
	Items []*SslCert `json:"items,omitempty"`
	// Kind: This is always `sql#sslCertsList`.
	Kind string `json:"kind,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Items") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SslCertsListResponse: SslCerts list response.

func (*SslCertsListResponse) MarshalJSON 

func (s *SslCertsListResponse) MarshalJSON() ([]byte, error)

type SslCertsService 

type SslCertsService struct {
	// contains filtered or unexported fields
}

func NewSslCertsService 

func NewSslCertsService(s *Service) *SslCertsService

func (*SslCertsService) CreateEphemeral 

func (r *SslCertsService) CreateEphemeral(project string, instance string, sslcertscreateephemeralrequest *SslCertsCreateEphemeralRequest) *SslCertsCreateEphemeralCall

CreateEphemeral: Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the Cloud SQL project.

func (*SslCertsService) Delete 

func (r *SslCertsService) Delete(project string, instance string, sha1Fingerprint string) *SslCertsDeleteCall

Delete: Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance. - sha1Fingerprint: Sha1 FingerPrint.

func (*SslCertsService) Get 

func (r *SslCertsService) Get(project string, instance string, sha1Fingerprint string) *SslCertsGetCall

Get: Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance. - sha1Fingerprint: Sha1 FingerPrint.

func (*SslCertsService) Insert 

func (r *SslCertsService) Insert(project string, instance string, sslcertsinsertrequest *SslCertsInsertRequest) *SslCertsInsertCall

Insert: Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*SslCertsService) List 

func (r *SslCertsService) List(project string, instance string) *SslCertsListCall

List: Lists all of the current SSL certificates for the instance.

- instance: Cloud SQL instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

type SyncFlags added in v0.55.0 

type SyncFlags struct {
	// Name: The name of the flag.
	Name string `json:"name,omitempty"`
	// Value: The value of the flag. This field must be omitted if the flag doesn't
	// take a value.
	Value string `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SyncFlags: Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.

func (*SyncFlags) MarshalJSON added in v0.55.0 

func (s *SyncFlags) MarshalJSON() ([]byte, error)

type Tier 

type Tier struct {
	// DiskQuota: The maximum disk size of this tier in bytes.
	DiskQuota int64 `json:"DiskQuota,omitempty,string"`
	// RAM: The maximum RAM usage of this tier in bytes.
	RAM int64 `json:"RAM,omitempty,string"`
	// Kind: This is always `sql#tier`.
	Kind string `json:"kind,omitempty"`
	// Region: The applicable regions for this tier.
	Region []string `json:"region,omitempty"`
	// Tier: An identifier for the machine type, for example, `db-custom-1-3840`.
	// For related information, see Pricing (/sql/pricing).
	Tier string `json:"tier,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DiskQuota") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DiskQuota") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Tier: A Google Cloud SQL service tier resource.

func (*Tier) MarshalJSON 

func (s *Tier) MarshalJSON() ([]byte, error)

type TiersListCall 

type TiersListCall struct {
	// contains filtered or unexported fields
}

func (*TiersListCall) Context 

func (c *TiersListCall) Context(ctx context.Context) *TiersListCall

Context sets the context to be used in this call's Do method.

func (*TiersListCall) Do 

func (c *TiersListCall) Do(opts ...googleapi.CallOption) (*TiersListResponse, error)

Do executes the "sql.tiers.list" call. Any non-2xx status code is an error. Response headers are in either *TiersListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TiersListCall) Fields 

func (c *TiersListCall) Fields(s ...googleapi.Field) *TiersListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*TiersListCall) Header 

func (c *TiersListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*TiersListCall) IfNoneMatch 

func (c *TiersListCall) IfNoneMatch(entityTag string) *TiersListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type TiersListResponse 

type TiersListResponse struct {
	// Items: List of tiers.
	Items []*Tier `json:"items,omitempty"`
	// Kind: This is always `sql#tiersList`.
	Kind string `json:"kind,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Items") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TiersListResponse: Tiers list response.

func (*TiersListResponse) MarshalJSON 

func (s *TiersListResponse) MarshalJSON() ([]byte, error)

type TiersService 

type TiersService struct {
	// contains filtered or unexported fields
}

func NewTiersService 

func NewTiersService(s *Service) *TiersService

func (*TiersService) List 

func (r *TiersService) List(project string) *TiersListCall

List: Lists all available machine types (tiers) for Cloud SQL, for example, `db-custom-1-3840`. For related information, see Pricing (/sql/pricing).

- project: Project ID of the project for which to list tiers.

type TruncateLogContext 

type TruncateLogContext struct {
	// Kind: This is always `sql#truncateLogContext`.
	Kind string `json:"kind,omitempty"`
	// LogType: The type of log to truncate. Valid values are `MYSQL_GENERAL_TABLE`
	// and `MYSQL_SLOW_TABLE`.
	LogType string `json:"logType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Kind") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TruncateLogContext: Database Instance truncate log context.

func (*TruncateLogContext) MarshalJSON 

func (s *TruncateLogContext) MarshalJSON() ([]byte, error)

type User 

type User struct {
	// DualPasswordType: Dual password status for the user.
	//
	// Possible values:
	//   "DUAL_PASSWORD_TYPE_UNSPECIFIED" - The default value.
	//   "NO_MODIFY_DUAL_PASSWORD" - Do not update the user's dual password status.
	//   "NO_DUAL_PASSWORD" - No dual password usable for connecting using this
	// user.
	//   "DUAL_PASSWORD" - Dual password usable for connecting using this user.
	DualPasswordType string `json:"dualPasswordType,omitempty"`
	// Etag: This field is deprecated and will be removed from a future version of
	// the API.
	Etag string `json:"etag,omitempty"`
	// Host: Optional. The host 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 cannot be updated
	// after insertion. For a MySQL instance, it's required; for a PostgreSQL or
	// SQL Server instance, it's optional.
	Host string `json:"host,omitempty"`
	// Instance: The name of the Cloud SQL instance. This does not include the
	// project ID. Can be omitted for *update* because it is already specified on
	// the URL.
	Instance string `json:"instance,omitempty"`
	// Kind: This is always `sql#user`.
	Kind string `json:"kind,omitempty"`
	// Name: The name of the user in the Cloud SQL instance. Can be omitted for
	// `update` because it is already specified in the URL.
	Name string `json:"name,omitempty"`
	// Password: The password for the user.
	Password string `json:"password,omitempty"`
	// PasswordPolicy: User level password validation policy.
	PasswordPolicy *UserPasswordValidationPolicy `json:"passwordPolicy,omitempty"`
	// Project: The project ID of the project containing the Cloud SQL database.
	// The Google apps domain is prefixed if applicable. Can be omitted for
	// *update* because it is already specified on the URL.
	Project              string                `json:"project,omitempty"`
	SqlserverUserDetails *SqlServerUserDetails `json:"sqlserverUserDetails,omitempty"`
	// Type: The user type. It determines the method to authenticate the user
	// during login. The default is the database's built-in user type.
	//
	// Possible values:
	//   "BUILT_IN" - The database's built-in user type.
	//   "CLOUD_IAM_USER" - Cloud IAM user.
	//   "CLOUD_IAM_SERVICE_ACCOUNT" - Cloud IAM service account.
	//   "CLOUD_IAM_GROUP" - Cloud IAM group non-login user.
	//   "CLOUD_IAM_GROUP_USER" - Cloud IAM group login user.
	//   "CLOUD_IAM_GROUP_SERVICE_ACCOUNT" - Cloud IAM group service account.
	Type string `json:"type,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DualPasswordType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DualPasswordType") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

User: A Cloud SQL user resource.

func (*User) MarshalJSON 

func (s *User) MarshalJSON() ([]byte, error)

type UserPasswordValidationPolicy added in v0.61.0 

type UserPasswordValidationPolicy struct {
	// AllowedFailedAttempts: Number of failed login attempts allowed before user
	// get locked.
	AllowedFailedAttempts int64 `json:"allowedFailedAttempts,omitempty"`
	// EnableFailedAttemptsCheck: If true, failed login attempts check will be
	// enabled.
	EnableFailedAttemptsCheck bool `json:"enableFailedAttemptsCheck,omitempty"`
	// EnablePasswordVerification: If true, the user must specify the current
	// password before changing the password. This flag is supported only for
	// MySQL.
	EnablePasswordVerification bool `json:"enablePasswordVerification,omitempty"`
	// PasswordExpirationDuration: Expiration duration after password is updated.
	PasswordExpirationDuration string `json:"passwordExpirationDuration,omitempty"`
	// Status: Output only. Read-only password status.
	Status *PasswordStatus `json:"status,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedFailedAttempts") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowedFailedAttempts") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UserPasswordValidationPolicy: User level password validation policy.

func (*UserPasswordValidationPolicy) MarshalJSON added in v0.61.0 

func (s *UserPasswordValidationPolicy) MarshalJSON() ([]byte, error)

type UsersDeleteCall 

type UsersDeleteCall struct {
	// contains filtered or unexported fields
}

func (*UsersDeleteCall) Context 

func (c *UsersDeleteCall) Context(ctx context.Context) *UsersDeleteCall

Context sets the context to be used in this call's Do method.

func (*UsersDeleteCall) Do 

func (c *UsersDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.users.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersDeleteCall) Fields 

func (c *UsersDeleteCall) Fields(s ...googleapi.Field) *UsersDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersDeleteCall) Header 

func (c *UsersDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersDeleteCall) Host added in v0.14.0 

func (c *UsersDeleteCall) Host(host string) *UsersDeleteCall

Host sets the optional parameter "host": Host of the user in the instance.

func (*UsersDeleteCall) Name added in v0.14.0 

func (c *UsersDeleteCall) Name(name string) *UsersDeleteCall

Name sets the optional parameter "name": Name of the user in the instance.

type UsersGetCall added in v0.87.0 

type UsersGetCall struct {
	// contains filtered or unexported fields
}

func (*UsersGetCall) Context added in v0.87.0 

func (c *UsersGetCall) Context(ctx context.Context) *UsersGetCall

Context sets the context to be used in this call's Do method.

func (*UsersGetCall) Do added in v0.87.0 

func (c *UsersGetCall) Do(opts ...googleapi.CallOption) (*User, error)

Do executes the "sql.users.get" call. Any non-2xx status code is an error. Response headers are in either *User.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersGetCall) Fields added in v0.87.0 

func (c *UsersGetCall) Fields(s ...googleapi.Field) *UsersGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersGetCall) Header added in v0.87.0 

func (c *UsersGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersGetCall) Host added in v0.101.0 

func (c *UsersGetCall) Host(host string) *UsersGetCall

Host sets the optional parameter "host": Host of a user of the instance.

func (*UsersGetCall) IfNoneMatch added in v0.87.0 

func (c *UsersGetCall) IfNoneMatch(entityTag string) *UsersGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersInsertCall 

type UsersInsertCall struct {
	// contains filtered or unexported fields
}

func (*UsersInsertCall) Context 

func (c *UsersInsertCall) Context(ctx context.Context) *UsersInsertCall

Context sets the context to be used in this call's Do method.

func (*UsersInsertCall) Do 

func (c *UsersInsertCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.users.insert" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersInsertCall) Fields 

func (c *UsersInsertCall) Fields(s ...googleapi.Field) *UsersInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersInsertCall) Header 

func (c *UsersInsertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type UsersListCall 

type UsersListCall struct {
	// contains filtered or unexported fields
}

func (*UsersListCall) Context 

func (c *UsersListCall) Context(ctx context.Context) *UsersListCall

Context sets the context to be used in this call's Do method.

func (*UsersListCall) Do 

func (c *UsersListCall) Do(opts ...googleapi.CallOption) (*UsersListResponse, error)

Do executes the "sql.users.list" call. Any non-2xx status code is an error. Response headers are in either *UsersListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersListCall) Fields 

func (c *UsersListCall) Fields(s ...googleapi.Field) *UsersListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersListCall) Header 

func (c *UsersListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersListCall) IfNoneMatch 

func (c *UsersListCall) IfNoneMatch(entityTag string) *UsersListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type UsersListResponse 

type UsersListResponse struct {
	// Items: List of user resources in the instance.
	Items []*User `json:"items,omitempty"`
	// Kind: This is always *sql#usersList*.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: Unused.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Items") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UsersListResponse: User list response.

func (*UsersListResponse) MarshalJSON 

func (s *UsersListResponse) MarshalJSON() ([]byte, error)

type UsersService 

type UsersService struct {
	// contains filtered or unexported fields
}

func NewUsersService 

func NewUsersService(s *Service) *UsersService

func (*UsersService) Delete 

func (r *UsersService) Delete(project string, instance string) *UsersDeleteCall

Delete: Deletes a user from a Cloud SQL instance.

- instance: Database instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*UsersService) Get added in v0.87.0 

func (r *UsersService) Get(project string, instance string, name string) *UsersGetCall

Get: Retrieves a resource containing information about a user.

- instance: Database instance ID. This does not include the project ID. - name: User of the instance. - project: Project ID of the project that contains the instance.

func (*UsersService) Insert 

func (r *UsersService) Insert(project string, instance string, user *User) *UsersInsertCall

Insert: Creates a new user in a Cloud SQL instance.

- instance: Database instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*UsersService) List 

func (r *UsersService) List(project string, instance string) *UsersListCall

List: Lists users in the specified Cloud SQL instance.

- instance: Database instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

func (*UsersService) Update 

func (r *UsersService) Update(project string, instance string, user *User) *UsersUpdateCall

Update: Updates an existing user in a Cloud SQL instance.

- instance: Database instance ID. This does not include the project ID. - project: Project ID of the project that contains the instance.

type UsersUpdateCall 

type UsersUpdateCall struct {
	// contains filtered or unexported fields
}

func (*UsersUpdateCall) Context 

func (c *UsersUpdateCall) Context(ctx context.Context) *UsersUpdateCall

Context sets the context to be used in this call's Do method.

func (*UsersUpdateCall) Do 

func (c *UsersUpdateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "sql.users.update" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*UsersUpdateCall) Fields 

func (c *UsersUpdateCall) Fields(s ...googleapi.Field) *UsersUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*UsersUpdateCall) Header 

func (c *UsersUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*UsersUpdateCall) Host 

func (c *UsersUpdateCall) Host(host string) *UsersUpdateCall

Host sets the optional parameter "host": Host of the user in the instance.

func (*UsersUpdateCall) Name added in v0.14.0 

func (c *UsersUpdateCall) Name(name string) *UsersUpdateCall

Name sets the optional parameter "name": Name of the user in the instance.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.