Show / Hide Table of Contents

Class Instance

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

Inheritance
object
Instance
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Spanner.v1.Data
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class Instance : IDirectResponseSchema

Properties

Config

Required. The name of the instance's configuration. Values are of the form projects//instanceConfigs/. See also InstanceConfig and ListInstanceConfigs.

Declaration
[JsonProperty("config")]
public virtual string Config { get; set; }
Property Value
Type Description
string

CreateTime

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

Declaration
[JsonProperty("createTime")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

DisplayName

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.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

EndpointUris

Deprecated. This field is not populated.

Declaration
[JsonProperty("endpointUris")]
public virtual IList<string> EndpointUris { get; set; }
Property Value
Type Description
IList<string>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FreeInstanceMetadata

Free instance metadata. Only populated for free instances.

Declaration
[JsonProperty("freeInstanceMetadata")]
public virtual FreeInstanceMetadata FreeInstanceMetadata { get; set; }
Property Value
Type Description
FreeInstanceMetadata

InstanceType

The InstanceType of the current instance.

Declaration
[JsonProperty("instanceType")]
public virtual string InstanceType { get; set; }
Property Value
Type Description
string

Labels

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{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.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NodeCount

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. This may be zero in API responses for instances that are not yet in state READY. See the documentation for more information about nodes and processing units.

Declaration
[JsonProperty("nodeCount")]
public virtual int? NodeCount { get; set; }
Property Value
Type Description
int?

ProcessingUnits

The number of processing units allocated to this instance. At most one of 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. This may be zero in API responses for instances that are not yet in state READY. See the documentation for more information about nodes and processing units.

Declaration
[JsonProperty("processingUnits")]
public virtual int? ProcessingUnits { get; set; }
Property Value
Type Description
int?

State

Output only. The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For UpdateInstance, the state must be either omitted or set to READY.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

UpdateTime

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

Declaration
[JsonProperty("updateTime")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX