sql.v1beta1.sqlInstance
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withDatabaseVersion(databaseVersion)
fn withMaintenanceVersion(maintenanceVersion)
fn withRegion(region)
fn withResourceID(resourceID)
obj spec.encryptionKMSCryptoKeyRef
obj spec.masterInstanceRef
obj spec.replicaConfiguration
fn withCaCertificate(caCertificate)
fn withClientCertificate(clientCertificate)
fn withClientKey(clientKey)
fn withConnectRetryInterval(connectRetryInterval)
fn withDumpFilePath(dumpFilePath)
fn withFailoverTarget(failoverTarget)
fn withMasterHeartbeatPeriod(masterHeartbeatPeriod)
fn withSslCipher(sslCipher)
fn withUsername(username)
fn withVerifyServerCertificate(verifyServerCertificate)
obj spec.replicaConfiguration.password
obj spec.rootPassword
obj spec.settings
fn withActivationPolicy(activationPolicy)
fn withAuthorizedGaeApplications(authorizedGaeApplications)
fn withAuthorizedGaeApplicationsMixin(authorizedGaeApplications)
fn withAvailabilityType(availabilityType)
fn withCollation(collation)
fn withConnectorEnforcement(connectorEnforcement)
fn withCrashSafeReplication(crashSafeReplication)
fn withDatabaseFlags(databaseFlags)
fn withDatabaseFlagsMixin(databaseFlags)
fn withDiskAutoresize(diskAutoresize)
fn withDiskAutoresizeLimit(diskAutoresizeLimit)
fn withDiskSize(diskSize)
fn withDiskType(diskType)
fn withPricingPlan(pricingPlan)
fn withReplicationType(replicationType)
fn withTier(tier)
fn withTimeZone(timeZone)
obj spec.settings.activeDirectoryConfig
obj spec.settings.backupConfiguration
fn withBinaryLogEnabled(binaryLogEnabled)
fn withEnabled(enabled)
fn withLocation(location)
fn withPointInTimeRecoveryEnabled(pointInTimeRecoveryEnabled)
fn withStartTime(startTime)
fn withTransactionLogRetentionDays(transactionLogRetentionDays)
obj spec.settings.backupConfiguration.backupRetentionSettings
obj spec.settings.databaseFlags
obj spec.settings.denyMaintenancePeriod
obj spec.settings.insightsConfig
obj spec.settings.ipConfiguration
fn withAllocatedIpRange(allocatedIpRange)
fn withAuthorizedNetworks(authorizedNetworks)
fn withAuthorizedNetworksMixin(authorizedNetworks)
fn withIpv4Enabled(ipv4Enabled)
fn withRequireSsl(requireSsl)
obj spec.settings.ipConfiguration.authorizedNetworks
obj spec.settings.ipConfiguration.privateNetworkRef
obj spec.settings.locationPreference
obj spec.settings.maintenanceWindow
obj spec.settings.passwordValidationPolicy
obj spec.settings.sqlServerAuditConfig
Fields
fn new
new(name)
new returns an instance of SQLInstance
obj metadata
"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
fn metadata.withAnnotations
withAnnotations(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withFinalizers
withFinalizers(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
fn metadata.withGeneration
withGeneration(generation)
"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
fn metadata.withLabels
withLabels(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
fn metadata.withLabelsMixin
withLabelsMixin(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
fn metadata.withNamespace
withNamespace(namespace)
"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"
fn metadata.withSelfLink
withSelfLink(selfLink)
"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."
fn metadata.withUid
withUid(uid)
"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
obj spec
fn spec.withDatabaseVersion
withDatabaseVersion(databaseVersion)
"The MySQL, PostgreSQL or SQL Server (beta) version to use. Supported values include MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB. Database Version Policies includes an up-to-date reference of supported versions."
fn spec.withMaintenanceVersion
withMaintenanceVersion(maintenanceVersion)
"Maintenance version."
fn spec.withRegion
withRegion(region)
"Immutable. The region the instance will sit in. Note, Cloud SQL is not available in all regions. A valid region must be provided to use this resource. If a region is not provided in the resource definition, the provider region will be used instead, but this will be an apply-time error for instances if the provider region is not supported with Cloud SQL. If you choose not to provide the region argument for this resource, make sure you understand this."
fn spec.withResourceID
withResourceID(resourceID)
"Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of metadata.name
is used as the default."
obj spec.encryptionKMSCryptoKeyRef
fn spec.encryptionKMSCryptoKeyRef.withExternal
withExternal(external)
"Allowed value: The selfLink
field of a KMSCryptoKey
resource."
fn spec.encryptionKMSCryptoKeyRef.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.encryptionKMSCryptoKeyRef.withNamespace
withNamespace(namespace)
"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"
obj spec.masterInstanceRef
fn spec.masterInstanceRef.withExternal
withExternal(external)
"Allowed value: The name
field of a SQLInstance
resource."
fn spec.masterInstanceRef.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.masterInstanceRef.withNamespace
withNamespace(namespace)
"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"
obj spec.replicaConfiguration
"The configuration for replication."
fn spec.replicaConfiguration.withCaCertificate
withCaCertificate(caCertificate)
"Immutable. PEM representation of the trusted CA's x509 certificate."
fn spec.replicaConfiguration.withClientCertificate
withClientCertificate(clientCertificate)
"Immutable. PEM representation of the replica's x509 certificate."
fn spec.replicaConfiguration.withClientKey
withClientKey(clientKey)
"Immutable. PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate."
fn spec.replicaConfiguration.withConnectRetryInterval
withConnectRetryInterval(connectRetryInterval)
"Immutable. The number of seconds between connect retries. MySQL's default is 60 seconds."
fn spec.replicaConfiguration.withDumpFilePath
withDumpFilePath(dumpFilePath)
"Immutable. Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename."
fn spec.replicaConfiguration.withFailoverTarget
withFailoverTarget(failoverTarget)
"Immutable. Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance."
fn spec.replicaConfiguration.withMasterHeartbeatPeriod
withMasterHeartbeatPeriod(masterHeartbeatPeriod)
"Immutable. Time in ms between replication heartbeats."
fn spec.replicaConfiguration.withSslCipher
withSslCipher(sslCipher)
"Immutable. Permissible ciphers for use in SSL encryption."
fn spec.replicaConfiguration.withUsername
withUsername(username)
"Immutable. Username for replication connection."
fn spec.replicaConfiguration.withVerifyServerCertificate
withVerifyServerCertificate(verifyServerCertificate)
"Immutable. True if the master's common name value is checked during the SSL handshake."
obj spec.replicaConfiguration.password
"Immutable. Password for the replication connection."
fn spec.replicaConfiguration.password.withValue
withValue(value)
"Value of the field. Cannot be used if 'valueFrom' is specified."
obj spec.replicaConfiguration.password.valueFrom
"Source for the field's value. Cannot be used if 'value' is specified."
obj spec.replicaConfiguration.password.valueFrom.secretKeyRef
"Reference to a value with the given key in the given Secret in the resource's namespace."
fn spec.replicaConfiguration.password.valueFrom.secretKeyRef.withKey
withKey(key)
"Key that identifies the value to be extracted."
fn spec.replicaConfiguration.password.valueFrom.secretKeyRef.withName
withName(name)
"Name of the Secret to extract a value from."
obj spec.rootPassword
"Immutable. Initial root password. Required for MS SQL Server."
fn spec.rootPassword.withValue
withValue(value)
"Value of the field. Cannot be used if 'valueFrom' is specified."
obj spec.rootPassword.valueFrom
"Source for the field's value. Cannot be used if 'value' is specified."
obj spec.rootPassword.valueFrom.secretKeyRef
"Reference to a value with the given key in the given Secret in the resource's namespace."
fn spec.rootPassword.valueFrom.secretKeyRef.withKey
withKey(key)
"Key that identifies the value to be extracted."
fn spec.rootPassword.valueFrom.secretKeyRef.withName
withName(name)
"Name of the Secret to extract a value from."
obj spec.settings
"The settings to use for the database. The configuration is detailed below."
fn spec.settings.withActivationPolicy
withActivationPolicy(activationPolicy)
"This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND."
fn spec.settings.withAuthorizedGaeApplications
withAuthorizedGaeApplications(authorizedGaeApplications)
"DEPRECATED. This property is only applicable to First Generation instances, and First Generation instances are now deprecated. see https://cloud.google.com/sql/docs/mysql/deprecation-notice for information on how to upgrade to Second Generation instances.\nSpecifying this field has no-ops; it's recommended to remove this field from your configuration."
fn spec.settings.withAuthorizedGaeApplicationsMixin
withAuthorizedGaeApplicationsMixin(authorizedGaeApplications)
"DEPRECATED. This property is only applicable to First Generation instances, and First Generation instances are now deprecated. see https://cloud.google.com/sql/docs/mysql/deprecation-notice for information on how to upgrade to Second Generation instances.\nSpecifying this field has no-ops; it's recommended to remove this field from your configuration."
Note: This function appends passed data to existing values
fn spec.settings.withAvailabilityType
withAvailabilityType(availabilityType)
"The availability type of the Cloud SQL instance, high availability\n(REGIONAL) or single zone (ZONAL). For all instances, ensure that\nsettings.backup_configuration.enabled is set to true.\nFor MySQL instances, ensure that settings.backup_configuration.binary_log_enabled is set to true.\nFor Postgres instances, ensure that settings.backup_configuration.point_in_time_recovery_enabled\nis set to true. Defaults to ZONAL."
fn spec.settings.withCollation
withCollation(collation)
"Immutable. The name of server instance collation."
fn spec.settings.withConnectorEnforcement
withConnectorEnforcement(connectorEnforcement)
"Specifies if connections must use Cloud SQL connectors."
fn spec.settings.withCrashSafeReplication
withCrashSafeReplication(crashSafeReplication)
"DEPRECATED. This property is only applicable to First Generation instances, and First Generation instances are now deprecated. see https://cloud.google.com/sql/docs/mysql/deprecation-notice for information on how to upgrade to Second Generation instances.\nSpecifying this field has no-ops; it's recommended to remove this field from your configuration."
fn spec.settings.withDatabaseFlags
withDatabaseFlags(databaseFlags)
fn spec.settings.withDatabaseFlagsMixin
withDatabaseFlagsMixin(databaseFlags)
Note: This function appends passed data to existing values
fn spec.settings.withDiskAutoresize
withDiskAutoresize(diskAutoresize)
"Enables auto-resizing of the storage size. Defaults to true."
fn spec.settings.withDiskAutoresizeLimit
withDiskAutoresizeLimit(diskAutoresizeLimit)
"The maximum size, in GB, to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit."
fn spec.settings.withDiskSize
withDiskSize(diskSize)
"The size of data disk, in GB. Size of a running instance cannot be reduced but can be increased. The minimum value is 10GB."
fn spec.settings.withDiskType
withDiskType(diskType)
"The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD."
fn spec.settings.withPricingPlan
withPricingPlan(pricingPlan)
"Pricing plan for this instance, can only be PER_USE."
fn spec.settings.withReplicationType
withReplicationType(replicationType)
"DEPRECATED. This property is only applicable to First Generation instances, and First Generation instances are now deprecated. see https://cloud.google.com/sql/docs/mysql/deprecation-notice for information on how to upgrade to Second Generation instances.\nSpecifying this field has no-ops; it's recommended to remove this field from your configuration."
fn spec.settings.withTier
withTier(tier)
"The machine type to use. See tiers for more details and supported versions. Postgres supports only shared-core machine types, and custom machine types such as db-custom-2-13312. See the Custom Machine Type Documentation to learn about specifying custom machine types."
fn spec.settings.withTimeZone
withTimeZone(timeZone)
"Immutable. The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format."
obj spec.settings.activeDirectoryConfig
fn spec.settings.activeDirectoryConfig.withDomain
withDomain(domain)
"Domain name of the Active Directory for SQL Server (e.g., mydomain.com)."
obj spec.settings.backupConfiguration
fn spec.settings.backupConfiguration.withBinaryLogEnabled
withBinaryLogEnabled(binaryLogEnabled)
"True if binary logging is enabled. If settings.backup_configuration.enabled is false, this must be as well. Can only be used with MySQL."
fn spec.settings.backupConfiguration.withEnabled
withEnabled(enabled)
"True if backup configuration is enabled."
fn spec.settings.backupConfiguration.withLocation
withLocation(location)
"Location of the backup configuration."
fn spec.settings.backupConfiguration.withPointInTimeRecoveryEnabled
withPointInTimeRecoveryEnabled(pointInTimeRecoveryEnabled)
"True if Point-in-time recovery is enabled."
fn spec.settings.backupConfiguration.withStartTime
withStartTime(startTime)
"HH:MM format time indicating when backup configuration starts."
fn spec.settings.backupConfiguration.withTransactionLogRetentionDays
withTransactionLogRetentionDays(transactionLogRetentionDays)
"The number of days of transaction logs we retain for point in time restore, from 1-7."
obj spec.settings.backupConfiguration.backupRetentionSettings
fn spec.settings.backupConfiguration.backupRetentionSettings.withRetainedBackups
withRetainedBackups(retainedBackups)
"Number of backups to retain."
fn spec.settings.backupConfiguration.backupRetentionSettings.withRetentionUnit
withRetentionUnit(retentionUnit)
"The unit that 'retainedBackups' represents. Defaults to COUNT."
obj spec.settings.databaseFlags
fn spec.settings.databaseFlags.withName
withName(name)
"Name of the flag."
fn spec.settings.databaseFlags.withValue
withValue(value)
"Value of the flag."
obj spec.settings.denyMaintenancePeriod
fn spec.settings.denyMaintenancePeriod.withEndDate
withEndDate(endDate)
"End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01."
fn spec.settings.denyMaintenancePeriod.withStartDate
withStartDate(startDate)
"Start date after which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01."
fn spec.settings.denyMaintenancePeriod.withTime
withTime(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."
obj spec.settings.insightsConfig
"Configuration of Query Insights."
fn spec.settings.insightsConfig.withQueryInsightsEnabled
withQueryInsightsEnabled(queryInsightsEnabled)
"True if Query Insights feature is enabled."
fn spec.settings.insightsConfig.withQueryPlansPerMinute
withQueryPlansPerMinute(queryPlansPerMinute)
"Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5."
fn spec.settings.insightsConfig.withQueryStringLength
withQueryStringLength(queryStringLength)
"Maximum query length stored in bytes. Between 256 and 4500. Default to 1024."
fn spec.settings.insightsConfig.withRecordApplicationTags
withRecordApplicationTags(recordApplicationTags)
"True if Query Insights will record application tags from query when enabled."
fn spec.settings.insightsConfig.withRecordClientAddress
withRecordClientAddress(recordClientAddress)
"True if Query Insights will record client address when enabled."
obj spec.settings.ipConfiguration
fn spec.settings.ipConfiguration.withAllocatedIpRange
withAllocatedIpRange(allocatedIpRange)
"The name of the allocated ip range for the private ip CloudSQL 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. Specifically, the name must be 1-63 characters long and match the regular expression a-z?."
fn spec.settings.ipConfiguration.withAuthorizedNetworks
withAuthorizedNetworks(authorizedNetworks)
fn spec.settings.ipConfiguration.withAuthorizedNetworksMixin
withAuthorizedNetworksMixin(authorizedNetworks)
Note: This function appends passed data to existing values
fn spec.settings.ipConfiguration.withIpv4Enabled
withIpv4Enabled(ipv4Enabled)
"Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured."
fn spec.settings.ipConfiguration.withRequireSsl
withRequireSsl(requireSsl)
obj spec.settings.ipConfiguration.authorizedNetworks
fn spec.settings.ipConfiguration.authorizedNetworks.withExpirationTime
withExpirationTime(expirationTime)
fn spec.settings.ipConfiguration.authorizedNetworks.withName
withName(name)
fn spec.settings.ipConfiguration.authorizedNetworks.withValue
withValue(value)
obj spec.settings.ipConfiguration.privateNetworkRef
fn spec.settings.ipConfiguration.privateNetworkRef.withExternal
withExternal(external)
"Allowed value: The selfLink
field of a ComputeNetwork
resource."
fn spec.settings.ipConfiguration.privateNetworkRef.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.settings.ipConfiguration.privateNetworkRef.withNamespace
withNamespace(namespace)
"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"
obj spec.settings.locationPreference
fn spec.settings.locationPreference.withFollowGaeApplication
withFollowGaeApplication(followGaeApplication)
"A Google App Engine application whose zone to remain in. Must be in the same region as this instance."
fn spec.settings.locationPreference.withSecondaryZone
withSecondaryZone(secondaryZone)
"The preferred Compute Engine zone for the secondary/failover."
fn spec.settings.locationPreference.withZone
withZone(zone)
"The preferred compute engine zone."
obj spec.settings.maintenanceWindow
"Declares a one-hour maintenance window when an Instance can automatically restart to apply updates. The maintenance window is specified in UTC time."
fn spec.settings.maintenanceWindow.withDay
withDay(day)
"Day of week (1-7), starting on Monday."
fn spec.settings.maintenanceWindow.withHour
withHour(hour)
"Hour of day (0-23), ignored if day not set."
fn spec.settings.maintenanceWindow.withUpdateTrack
withUpdateTrack(updateTrack)
"Receive updates earlier (canary) or later (stable)."
obj spec.settings.passwordValidationPolicy
fn spec.settings.passwordValidationPolicy.withComplexity
withComplexity(complexity)
"Password complexity."
fn spec.settings.passwordValidationPolicy.withDisallowUsernameSubstring
withDisallowUsernameSubstring(disallowUsernameSubstring)
"Disallow username as a part of the password."
fn spec.settings.passwordValidationPolicy.withEnablePasswordPolicy
withEnablePasswordPolicy(enablePasswordPolicy)
"Whether the password policy is enabled or not."
fn spec.settings.passwordValidationPolicy.withMinLength
withMinLength(minLength)
"Minimum number of characters allowed."
fn spec.settings.passwordValidationPolicy.withPasswordChangeInterval
withPasswordChangeInterval(passwordChangeInterval)
"Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL."
fn spec.settings.passwordValidationPolicy.withReuseInterval
withReuseInterval(reuseInterval)
"Number of previous passwords that cannot be reused."
obj spec.settings.sqlServerAuditConfig
fn spec.settings.sqlServerAuditConfig.withRetentionInterval
withRetentionInterval(retentionInterval)
"How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\".."
fn spec.settings.sqlServerAuditConfig.withUploadInterval
withUploadInterval(uploadInterval)
"How often to upload generated audit files. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\"."
obj spec.settings.sqlServerAuditConfig.bucketRef
"The name of the destination bucket (e.g., gs://mybucket)."
fn spec.settings.sqlServerAuditConfig.bucketRef.withExternal
withExternal(external)
"Allowed value: The url
field of a StorageBucket
resource."
fn spec.settings.sqlServerAuditConfig.bucketRef.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.settings.sqlServerAuditConfig.bucketRef.withNamespace
withNamespace(namespace)
"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"