Class InstanceConfigInfo (6.62.0)

public class InstanceConfigInfo

Represents a Cloud Spanner instance config resource.

Inheritance

Object > InstanceConfigInfo

Static Methods

newBuilder(InstanceConfigId id)

public static InstanceConfigInfo.Builder newBuilder(InstanceConfigId id)
Parameter
NameDescription
idInstanceConfigId
Returns
TypeDescription
InstanceConfigInfo.Builder

newBuilder(InstanceConfigId id, InstanceConfigInfo baseConfig)

public static InstanceConfigInfo.Builder newBuilder(InstanceConfigId id, InstanceConfigInfo baseConfig)
Parameters
NameDescription
idInstanceConfigId
baseConfigInstanceConfigInfo
Returns
TypeDescription
InstanceConfigInfo.Builder

Constructors

InstanceConfigInfo(InstanceConfigId id, String displayName)

public InstanceConfigInfo(InstanceConfigId id, String displayName)

Use #newBuilder instead

Parameters
NameDescription
idInstanceConfigId
displayNameString

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

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

Use #newBuilder instead

Parameters
NameDescription
idInstanceConfigId
displayNameString
replicasList<ReplicaInfo>
leaderOptionsList<String>

Methods

equals(Object o)

public boolean equals(Object o)
Parameter
NameDescription
oObject
Returns
TypeDescription
boolean
Overrides

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.

Returns
TypeDescription
InstanceConfigInfo

getConfigType()

public InstanceConfigInfo.Type getConfigType()

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

Returns
TypeDescription
InstanceConfigInfo.Type

getDisplayName()

public String getDisplayName()

Returns the display name of this instance config.

Returns
TypeDescription
String

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.

Returns
TypeDescription
String

getId()

public InstanceConfigId getId()

Returns the id of this instance config.

Returns
TypeDescription
InstanceConfigId

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.

Returns
TypeDescription
Map<String,String>

getLeaderOptions()

public List<String> getLeaderOptions()

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

Returns
TypeDescription
List<String>

getOptionalReplicas()

public List<ReplicaInfo> getOptionalReplicas()

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

Returns
TypeDescription
List<ReplicaInfo>

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.

Returns
TypeDescription
boolean

getReplicas()

public List<ReplicaInfo> getReplicas()

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

Returns
TypeDescription
List<ReplicaInfo>

getState()

public InstanceConfigInfo.State getState()

The current instance config state.

Returns
TypeDescription
InstanceConfigInfo.State

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

toBuilder()

public InstanceConfigInfo.Builder toBuilder()
Returns
TypeDescription
InstanceConfigInfo.Builder

toString()

public String toString()
Returns
TypeDescription
String
Overrides