Class InstanceConfigInfo (6.85.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
Name Description
id InstanceConfigId
Returns
Type Description
InstanceConfigInfo.Builder

newBuilder(InstanceConfigId id, InstanceConfigInfo baseConfig)

public static InstanceConfigInfo.Builder newBuilder(InstanceConfigId id, InstanceConfigInfo baseConfig)
Parameters
Name Description
id InstanceConfigId
baseConfig InstanceConfigInfo
Returns
Type Description
InstanceConfigInfo.Builder

Constructors

InstanceConfigInfo(InstanceConfigId id, String displayName) (deprecated)

public InstanceConfigInfo(InstanceConfigId id, String displayName)

Use #newBuilder instead

Parameters
Name Description
id InstanceConfigId
displayName String

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

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

Use #newBuilder instead

Parameters
Name Description
id InstanceConfigId
displayName String
replicas List<ReplicaInfo>
leaderOptions List<String>

Methods

equals(Object o)

public boolean equals(Object o)
Parameter
Name Description
o Object
Returns
Type Description
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
Type Description
InstanceConfigInfo

getConfigType()

public InstanceConfigInfo.Type getConfigType()

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

Returns
Type Description
InstanceConfigInfo.Type

getDisplayName()

public String getDisplayName()

Returns the display name of this instance config.

Returns
Type Description
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
Type Description
String

getId()

public InstanceConfigId getId()

Returns the id of this instance config.

Returns
Type Description
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
Type Description
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
Type Description
List<String>

getOptionalReplicas()

public List<ReplicaInfo> getOptionalReplicas()

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

Returns
Type Description
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
Type Description
boolean

getReplicas()

public List<ReplicaInfo> getReplicas()

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

Returns
Type Description
List<ReplicaInfo>

getState()

public InstanceConfigInfo.State getState()

The current instance config state.

Returns
Type Description
InstanceConfigInfo.State

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

toBuilder()

public InstanceConfigInfo.Builder toBuilder()
Returns
Type Description
InstanceConfigInfo.Builder

toString()

public String toString()
Returns
Type Description
String
Overrides