Package com.google.cloud.spanner

Class InstanceConfigInfo

java.lang.Object

com.google.cloud.spanner.InstanceConfigInfo

Direct Known Subclasses:

InstanceConfig

public class InstanceConfigInfo
extends Object

Represents a Cloud Spanner instance config resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InstanceConfigInfo.Builder	Builder for InstanceConfigInfo.
static class	InstanceConfigInfo.InstanceConfigField	Represent an updatable field in Cloud Spanner InstanceConfig.
static class	InstanceConfigInfo.State	Type of the Instance config.
static class	InstanceConfigInfo.Type	Type of the Instance config.

Constructor Summary

Constructors

Constructor	Description
InstanceConfigInfo(InstanceConfigId id, String displayName)	Deprecated.
InstanceConfigInfo(InstanceConfigId id, String displayName, List<ReplicaInfo> replicas, List<String> leaderOptions)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
InstanceConfigInfo	getBaseConfig()	Base configuration, e.g.
InstanceConfigInfo.Type	getConfigType()	Config type, indicates whether this instance config is a Google or User Managed Configuration.
String	getDisplayName()	Returns the display name of this instance config.
String	getEtag()	etag, which is used for optimistic concurrency control as a way to help prevent simultaneous updates of an instance config from overwriting each other.
InstanceConfigId	getId()	Returns the id of this instance config.
Map<String,String>	getLabels()	Cloud Labels, which can be used to filter collections of resources.
List<String>	getLeaderOptions()	Allowed values of the default leader schema option for databases in instances that use this instance configuration.
List<ReplicaInfo>	getOptionalReplicas()	The available optional replicas to choose from for user managed configurations.
boolean	getReconciling()	If true, the instance config is being created or updated.
List<ReplicaInfo>	getReplicas()	The geographic placement of nodes in this instance configuration and their replication properties.
InstanceConfigInfo.State	getState()	The current instance config state.
int	hashCode()
static InstanceConfigInfo.Builder	newBuilder(InstanceConfigId id)
static InstanceConfigInfo.Builder	newBuilder(InstanceConfigId id, InstanceConfigInfo baseConfig)
InstanceConfigInfo.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InstanceConfigInfo

@Deprecated
public InstanceConfigInfo(InstanceConfigId id,
                          String displayName)

Deprecated.

Use newBuilder(com.google.cloud.spanner.InstanceConfigId) instead

InstanceConfigInfo

@Deprecated
public InstanceConfigInfo(InstanceConfigId id,
                          String displayName,
                          List<ReplicaInfo> replicas,
                          List<String> leaderOptions)

Deprecated.

Use newBuilder(com.google.cloud.spanner.InstanceConfigId) instead

Method Detail

getId

public InstanceConfigId getId()

Returns the id of this instance config.

getDisplayName

public String getDisplayName()

Returns the display name of this instance config.

getReplicas

public List<ReplicaInfo> getReplicas()

The geographic placement of nodes in this instance configuration and their replication properties.

getLeaderOptions

public List<String> getLeaderOptions()

Allowed values of the default leader schema option for databases in instances that use this instance configuration.

getOptionalReplicas

public List<ReplicaInfo> getOptionalReplicas()

The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.

getBaseConfig

public InstanceConfigInfo getBaseConfig()

Base configuration, e.g. projects/<project_name>/instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. The base config must refer to a configuration of type GOOGLE_MANAGED.

getConfigType

public InstanceConfigInfo.Type getConfigType()

Config type, indicates whether this instance config is a Google or User Managed Configuration.

getEtag

public String getEtag()

etag, which is used for optimistic concurrency control as a way to help prevent simultaneous updates of an instance config from overwriting each other.

getReconciling

public boolean getReconciling()

If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.

getState

public InstanceConfigInfo.State getState()

The current instance config state.

getLabels

public Map<String,String> getLabels()

Cloud Labels, which can be used to filter collections of resources. They can be used to control how resource metrics are aggregated.

newBuilder

public static InstanceConfigInfo.Builder newBuilder(InstanceConfigId id)

newBuilder

public static InstanceConfigInfo.Builder newBuilder(InstanceConfigId id,
                                                    InstanceConfigInfo baseConfig)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public InstanceConfigInfo.Builder toBuilder()

toString

public String toString()

Overrides:

toString in class Object