Class ProjectsResource.InstanceConfigsResource
The "instanceConfigs" collection of methods.
Inherited Members
Namespace: Google.Apis.Spanner.v1
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class ProjectsResource.InstanceConfigsResource
Constructors
InstanceConfigsResource(IClientService)
Constructs a new resource.
Declaration
public InstanceConfigsResource(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Properties
Operations
Gets the Operations resource.
Declaration
public virtual ProjectsResource.InstanceConfigsResource.OperationsResource Operations { get; }
Property Value
Type | Description |
---|---|
ProjectsResource.InstanceConfigsResource.OperationsResource |
SsdCaches
Gets the SsdCaches resource.
Declaration
public virtual ProjectsResource.InstanceConfigsResource.SsdCachesResource SsdCaches { get; }
Property Value
Type | Description |
---|---|
ProjectsResource.InstanceConfigsResource.SsdCachesResource |
Methods
Create(CreateInstanceConfigRequest, string)
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 config. 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 config'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 config'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 config. The metadata field type is CreateInstanceConfigMetadata. The response field type is
InstanceConfig, if successful. Authorization requires spanner.instanceConfigs.create
permission on the
resource parent.
Declaration
public virtual ProjectsResource.InstanceConfigsResource.CreateRequest Create(CreateInstanceConfigRequest body, string parent)
Parameters
Type | Name | Description |
---|---|---|
CreateInstanceConfigRequest | body | The body of the request. |
string | parent | Required. The name of the project in which to create the instance config. Values are of the form
|
Returns
Type | Description |
---|---|
ProjectsResource.InstanceConfigsResource.CreateRequest |
Delete(string)
Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If
any instances are using the config, returns FAILED_PRECONDITION
. Only user-managed configurations can
be deleted. Authorization requires spanner.instanceConfigs.delete
permission on the resource name.
Declaration
public virtual ProjectsResource.InstanceConfigsResource.DeleteRequest Delete(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the instance configuration to be deleted. Values are of the form
|
Returns
Type | Description |
---|---|
ProjectsResource.InstanceConfigsResource.DeleteRequest |
Get(string)
Gets information about a particular instance configuration.
Declaration
public virtual ProjectsResource.InstanceConfigsResource.GetRequest Get(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The name of the requested instance configuration. Values are of the form
|
Returns
Type | Description |
---|---|
ProjectsResource.InstanceConfigsResource.GetRequest |
List(string)
Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.
Declaration
public virtual ProjectsResource.InstanceConfigsResource.ListRequest List(string parent)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The name of the project for which a list of supported instance configurations is requested.
Values are of the form |
Returns
Type | Description |
---|---|
ProjectsResource.InstanceConfigsResource.ListRequest |
Patch(UpdateInstanceConfigRequest, string)
Updates an instance config. 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
config'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 instance config's new values are readable via the API. * The
instance config'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.
Declaration
public virtual ProjectsResource.InstanceConfigsResource.PatchRequest Patch(UpdateInstanceConfigRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
UpdateInstanceConfigRequest | body | The body of the request. |
string | name | A unique identifier for the instance configuration. Values are of the form
|
Returns
Type | Description |
---|---|
ProjectsResource.InstanceConfigsResource.PatchRequest |