com.google.api.services.spanner.v1

Class Spanner.Projects.InstanceConfigs

java.lang.Object

com.google.api.services.spanner.v1.Spanner.Projects.InstanceConfigs

Enclosing class:

Spanner.Projects

public class Spanner.Projects.InstanceConfigs
extends Object

The "instanceConfigs" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Spanner.Projects.InstanceConfigs.Create
class	Spanner.Projects.InstanceConfigs.Delete
class	Spanner.Projects.InstanceConfigs.Get
class	Spanner.Projects.InstanceConfigs.List
class	Spanner.Projects.InstanceConfigs.Operations The "operations" collection of methods.
class	Spanner.Projects.InstanceConfigs.Patch
class	Spanner.Projects.InstanceConfigs.SsdCaches The "ssdCaches" collection of methods.

Constructor Summary

Constructors

Constructor and Description
InstanceConfigs()

Method Summary

Modifier and Type	Method and Description
Spanner.Projects.InstanceConfigs.Create	create(String parent, CreateInstanceConfigRequest content) Creates an instance configuration and begins preparing it to be used.
Spanner.Projects.InstanceConfigs.Delete	delete(String name) Deletes the instance configuration.
Spanner.Projects.InstanceConfigs.Get	get(String name) Gets information about a particular instance configuration.
Spanner.Projects.InstanceConfigs.List	list(String parent) Lists the supported instance configurations for a given project.
Spanner.Projects.InstanceConfigs.Operations	operations() An accessor for creating requests from the Operations collection.
Spanner.Projects.InstanceConfigs.Patch	patch(String name, UpdateInstanceConfigRequest content) Updates an instance configuration.
Spanner.Projects.InstanceConfigs.SsdCaches	ssdCaches() An accessor for creating requests from the SsdCaches collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstanceConfigs

public InstanceConfigs()

Method Detail

create

public Spanner.Projects.InstanceConfigs.Create create(String parent,
                                                      CreateInstanceConfigRequest content)
                                               throws IOException

Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance configuration. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance configuration's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance configuration's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance configuration. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent. Create a request for the method "instanceConfigs.create". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the project in which to create the instance configuration. Values are of the form `projects/`.

content - the CreateInstanceConfigRequest

Returns:

the request

Throws:

IOException

delete

public Spanner.Projects.InstanceConfigs.Delete delete(String name)
                                               throws IOException

Deletes the instance configuration. Deletion is only allowed when no instances are using the configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name. Create a request for the method "instanceConfigs.delete". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the instance configuration to be deleted. Values are of the form `projects//instanceConfigs/`

Returns:

the request

Throws:

IOException

get

public Spanner.Projects.InstanceConfigs.Get get(String name)
                                         throws IOException

Gets information about a particular instance configuration. Create a request for the method "instanceConfigs.get". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the requested instance configuration. Values are of the form `projects//instanceConfigs/`.

Returns:

the request

Throws:

IOException

list

public Spanner.Projects.InstanceConfigs.List list(String parent)
                                           throws IOException

Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations. Create a request for the method "instanceConfigs.list". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/`.

Returns:

the request

Throws:

IOException

patch

public Spanner.Projects.InstanceConfigs.Patch patch(String name,
                                                    UpdateInstanceConfigRequest content)
                                             throws IOException

Updates an instance configuration. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance configuration's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The new values of the instance configuration are readable via the API. * The instance configuration's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name. Create a request for the method "instanceConfigs.patch". This request holds the parameters needed by the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.

content - the UpdateInstanceConfigRequest

Returns:

the request

Throws:

IOException

operations

public Spanner.Projects.InstanceConfigs.Operations operations()

An accessor for creating requests from the Operations collection.

The typical use is:

    Spanner spanner = new Spanner(...);
    Spanner.Operations.List request = spanner.operations().list(parameters ...)
 

Returns:

the resource collection

ssdCaches

public Spanner.Projects.InstanceConfigs.SsdCaches ssdCaches()

An accessor for creating requests from the SsdCaches collection.

The typical use is:

    Spanner spanner = new Spanner(...);
    Spanner.SsdCaches.List request = spanner.ssdCaches().list(parameters ...)
 

Returns:

the resource collection