Google Cloud Spanner Instance Administration v1 API - Class Instance (5.0.0-beta05) 

public sealed class Instance : IMessage<Instance>, IEquatable<Instance>, IDeepCloneable<Instance>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Spanner Instance Administration v1 API class Instance.

An isolated set of Cloud Spanner resources on which databases can be hosted.

Inheritance

object > Instance

Namespace

Google.Cloud.Spanner.Admin.Instance.V1

Assembly

Google.Cloud.Spanner.Admin.Instance.V1.dll

Constructors

Instance()

public Instance()

Instance(Instance)

public Instance(Instance other)
Parameter
Name Description
other Instance

Properties

AutoscalingConfig

public AutoscalingConfig AutoscalingConfig { get; set; }

Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.

Property Value
Type Description
AutoscalingConfig

Config

public string Config { get; set; }

Required. The name of the instance's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].

Property Value
Type Description
string

ConfigAsInstanceConfigName

public InstanceConfigName ConfigAsInstanceConfigName { get; set; }

InstanceConfigName-typed view over the Config resource name property.

Property Value
Type Description
InstanceConfigName

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time at which the instance was created.

Property Value
Type Description
Timestamp

DefaultBackupScheduleType

public Instance.Types.DefaultBackupScheduleType DefaultBackupScheduleType { get; set; }

Optional. Controls the default backup behavior for new databases within the instance.

Note that AUTOMATIC is not permitted for free instances, as backups and backup schedules are not allowed for free instances.

In the GetInstance or ListInstances response, if the value of default_backup_schedule_type is unset or NONE, no default backup schedule will be created for new databases within the instance.

Property Value
Type Description
InstanceTypesDefaultBackupScheduleType

DisplayName

public string DisplayName { get; set; }

Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

Property Value
Type Description
string

Edition

public Instance.Types.Edition Edition { get; set; }

Optional. The Edition of the current instance.

Property Value
Type Description
InstanceTypesEdition

EndpointUris

public RepeatedField<string> EndpointUris { get; }

Deprecated. This field is not populated.

Property Value
Type Description
RepeatedFieldstring

InstanceName

public InstanceName InstanceName { get; set; }

Google.Cloud.Spanner.Common.V1.InstanceName-typed view over the Name resource name property.

Property Value
Type Description
Google.Cloud.Spanner.Common.V1.InstanceName

Labels

public MapField<string, string> Labels { get; }

Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

  • Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z][a-z0-9_-]{0,62}.
  • Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}.
  • No more than 64 labels can be associated with a given resource.

See https://goo.gl/xmQnxf for more information on and examples of labels.

If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length.

Property Value
Type Description
string

NodeCount

public int NodeCount { get; set; }

The number of nodes allocated to this instance. At most, one of either node_count or processing_units should be present in the message.

Users can set the node_count field to specify the target number of nodes allocated to the instance.

If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance.

This might be zero in API responses for instances that are not yet in the READY state.

If the instance has varying node count across replicas (achieved by setting asymmetric_autoscaling_options in autoscaling config), the node_count here is the maximum node count across all replicas.

For more information, see Compute capacity, nodes, and processing units.

Property Value
Type Description
int

ProcessingUnits

public int ProcessingUnits { get; set; }

The number of processing units allocated to this instance. At most, one of either processing_units or node_count should be present in the message.

Users can set the processing_units field to specify the target number of processing units allocated to the instance.

If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance.

This might be zero in API responses for instances that are not yet in the READY state.

If the instance has varying processing units per replica (achieved by setting asymmetric_autoscaling_options in autoscaling config), the processing_units here is the maximum processing units across all replicas.

For more information, see Compute capacity, nodes and processing units.

Property Value
Type Description
int

ReplicaComputeCapacity

public RepeatedField<ReplicaComputeCapacity> ReplicaComputeCapacity { get; }

Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity.

Property Value
Type Description
RepeatedFieldReplicaComputeCapacity

State

public Instance.Types.State State { get; set; }

Output only. The current instance state. For [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be either omitted or set to CREATING. For [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be either omitted or set to READY.

Property Value
Type Description
InstanceTypesState

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The time at which the instance was most recently updated.

Property Value
Type Description
Timestamp