Show / Hide Table of Contents

Class ProjectsResource.InstanceConfigsResource.PatchRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Operation>
SpannerBaseServiceRequest<Operation>
ProjectsResource.InstanceConfigsResource.PatchRequest
Implements
IClientServiceRequest<Operation>
IClientServiceRequest
Inherited Members
SpannerBaseServiceRequest<Operation>.Xgafv
SpannerBaseServiceRequest<Operation>.AccessToken
SpannerBaseServiceRequest<Operation>.Alt
SpannerBaseServiceRequest<Operation>.Callback
SpannerBaseServiceRequest<Operation>.Fields
SpannerBaseServiceRequest<Operation>.Key
SpannerBaseServiceRequest<Operation>.OauthToken
SpannerBaseServiceRequest<Operation>.PrettyPrint
SpannerBaseServiceRequest<Operation>.QuotaUser
SpannerBaseServiceRequest<Operation>.UploadType
SpannerBaseServiceRequest<Operation>.UploadProtocol
ClientServiceRequest<Operation>.Execute()
ClientServiceRequest<Operation>.ExecuteAsStream()
ClientServiceRequest<Operation>.ExecuteAsync()
ClientServiceRequest<Operation>.ExecuteAsync(CancellationToken)
ClientServiceRequest<Operation>.ExecuteAsStreamAsync()
ClientServiceRequest<Operation>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<Operation>.CreateRequest(bool?)
ClientServiceRequest<Operation>.GenerateRequestUri()
ClientServiceRequest<Operation>.GetDefaultETagAction(string)
ClientServiceRequest<Operation>.ETagAction
ClientServiceRequest<Operation>.ModifyRequest
ClientServiceRequest<Operation>.ValidateParameters
ClientServiceRequest<Operation>.ApiVersion
ClientServiceRequest<Operation>.RequestParameters
ClientServiceRequest<Operation>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Spanner.v1
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class ProjectsResource.InstanceConfigsResource.PatchRequest : SpannerBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest

Constructors

PatchRequest(IClientService, UpdateInstanceConfigRequest, string)

Constructs a new Patch request.

Declaration
public PatchRequest(IClientService service, UpdateInstanceConfigRequest body, string name)
Parameters
Type Name Description
IClientService service
UpdateInstanceConfigRequest body
string name

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Operation>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Operation>.MethodName

Name

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

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Operation>.RestPath

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides
ClientServiceRequest<Operation>.GetBody()

InitParameters()

Initializes Patch parameter list.

Declaration
protected override void InitParameters()
Overrides
SpannerBaseServiceRequest<Operation>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX