Show / Hide Table of Contents

Class ProjectsResource.InstancesResource.DatabasesResource.PatchRequest

Updates a Cloud Spanner database. The returned long-running operation can be used to track the progress of updating the database. If the named database does not exist, returns NOT_FOUND. While the operation is pending: * The database's reconciling field is set to true. * Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's cancel_time is set, the updates are reverted, and the operation terminates with a CANCELLED status. * New UpdateDatabase requests will return a FAILED_PRECONDITION error until the pending operation is done (returns successfully or with error). * Reading the database via the API continues to give the pre-request values. Upon completion of the returned operation: * The new values are in effect and readable via the API. * The database's reconciling field becomes false. The returned long-running operation will have a name of the format projects//instances//databases//operations/ and can be used to track the database modification. The metadata field type is UpdateDatabaseMetadata. The response field type is Database, if successful.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Operation>
SpannerBaseServiceRequest<Operation>
ProjectsResource.InstancesResource.DatabasesResource.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.InstancesResource.DatabasesResource.PatchRequest : SpannerBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest

Constructors

PatchRequest(IClientService, Database, string)

Constructs a new Patch request.

Declaration
public PatchRequest(IClientService service, Database body, string name)
Parameters
Type Name Description
IClientService service
Database 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

Required. The name of the database. Values are of the form projects//instances//databases/, where `` is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.

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

UpdateMask

Required. The list of fields to update. Currently, only enable_drop_protection field can be updated.

Declaration
[RequestParameter("updateMask", RequestParameterType.Query)]
public virtual object UpdateMask { get; set; }
Property Value
Type Description
object

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