public sealed class InstanceConfig : IMessage<InstanceConfig>, IEquatable<InstanceConfig>, IDeepCloneable<InstanceConfig>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Spanner Instance Administration v1 API class InstanceConfig.
A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
Implements
IMessageInstanceConfig, IEquatableInstanceConfig, IDeepCloneableInstanceConfig, IBufferMessage, IMessageNamespace
Google.Cloud.Spanner.Admin.Instance.V1Assembly
Google.Cloud.Spanner.Admin.Instance.V1.dll
Constructors
InstanceConfig()
public InstanceConfig()InstanceConfig(InstanceConfig)
public InstanceConfig(InstanceConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
InstanceConfig |
Properties
BaseConfig
public string BaseConfig { get; set; }Base configuration name, e.g. projects/<project_name>/instanceConfigs/nam3,
based on which this configuration is created. Only set for user managed
configurations. base_config must refer to a configuration of type
GOOGLE_MANAGED in the same project as this configuration.
| Property Value | |
|---|---|
| Type | Description |
string |
|
BaseConfigAsInstanceConfigName
public InstanceConfigName BaseConfigAsInstanceConfigName { get; set; }InstanceConfigName-typed view over the BaseConfig resource name property.
| Property Value | |
|---|---|
| Type | Description |
InstanceConfigName |
|
ConfigType
public InstanceConfig.Types.Type ConfigType { get; set; }Output only. Whether this instance configuration is a Google-managed or user-managed configuration.
| Property Value | |
|---|---|
| Type | Description |
InstanceConfigTypesType |
|
DisplayName
public string DisplayName { get; set; }The name of this instance configuration as it appears in UIs.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Etag
public string Etag { get; set; }etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly.
| Property Value | |
|---|---|
| Type | Description |
string |
|
InstanceConfigName
public InstanceConfigName InstanceConfigName { get; set; }InstanceConfigName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
InstanceConfigName |
|
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. Therefore, 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 |
|
LeaderOptions
public RepeatedField<string> LeaderOptions { get; }Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
Name
public string Name { get; set; }A unique identifier for the instance configuration. Values
are of the form
projects/<project>/instanceConfigs/[a-z][-a-z0-9]*.
User instance configuration must start with custom-.
| Property Value | |
|---|---|
| Type | Description |
string |
|
OptionalReplicas
public RepeatedField<ReplicaInfo> OptionalReplicas { get; }Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldReplicaInfo |
|
Reconciling
public bool Reconciling { get; set; }Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Replicas
public RepeatedField<ReplicaInfo> Replicas { get; }The geographic placement of nodes in this instance configuration and their replication properties.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldReplicaInfo |
|
State
public InstanceConfig.Types.State State { get; set; }Output only. The current instance configuration state. Applicable only for
USER_MANAGED configurations.
| Property Value | |
|---|---|
| Type | Description |
InstanceConfigTypesState |
|