Class protos.google.storage.v2.Storage (0.7.0)

Represents a Storage

Inheritance

$protobuf.rpc.Service > protos.google.storage.v2.Storage

Package

@google-cloud/storage-control

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Storage service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

bidiReadObject(request, callback)

public bidiReadObject(request: google.storage.v2.IBidiReadObjectRequest, callback: google.storage.v2.Storage.BidiReadObjectCallback): void;

Calls BidiReadObject.

Parameters
Name Description
request IBidiReadObjectRequest

BidiReadObjectRequest message or plain object
callback BidiReadObjectCallback

Node-style callback called with the error, if any, and BidiReadObjectResponse
Returns
Type Description
void

bidiReadObject(request)

public bidiReadObject(request: google.storage.v2.IBidiReadObjectRequest): Promise<google.storage.v2.BidiReadObjectResponse>;

Calls BidiReadObject.

Parameter
Name Description
request IBidiReadObjectRequest

BidiReadObjectRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.BidiReadObjectResponse>

Promise

bidiWriteObject(request, callback)

public bidiWriteObject(request: google.storage.v2.IBidiWriteObjectRequest, callback: google.storage.v2.Storage.BidiWriteObjectCallback): void;

Calls BidiWriteObject.

Parameters
Name Description
request IBidiWriteObjectRequest

BidiWriteObjectRequest message or plain object
callback BidiWriteObjectCallback

Node-style callback called with the error, if any, and BidiWriteObjectResponse
Returns
Type Description
void

bidiWriteObject(request)

public bidiWriteObject(request: google.storage.v2.IBidiWriteObjectRequest): Promise<google.storage.v2.BidiWriteObjectResponse>;

Calls BidiWriteObject.

Parameter
Name Description
request IBidiWriteObjectRequest

BidiWriteObjectRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.BidiWriteObjectResponse>

Promise

cancelResumableWrite(request, callback)

public cancelResumableWrite(request: google.storage.v2.ICancelResumableWriteRequest, callback: google.storage.v2.Storage.CancelResumableWriteCallback): void;

Calls CancelResumableWrite.

Parameters
Name Description
request ICancelResumableWriteRequest

CancelResumableWriteRequest message or plain object
callback CancelResumableWriteCallback

Node-style callback called with the error, if any, and CancelResumableWriteResponse
Returns
Type Description
void

cancelResumableWrite(request)

public cancelResumableWrite(request: google.storage.v2.ICancelResumableWriteRequest): Promise<google.storage.v2.CancelResumableWriteResponse>;

Calls CancelResumableWrite.

Parameter
Name Description
request ICancelResumableWriteRequest

CancelResumableWriteRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.CancelResumableWriteResponse>

Promise

composeObject(request, callback)

public composeObject(request: google.storage.v2.IComposeObjectRequest, callback: google.storage.v2.Storage.ComposeObjectCallback): void;

Calls ComposeObject.

Parameters
Name Description
request IComposeObjectRequest

ComposeObjectRequest message or plain object
callback ComposeObjectCallback

Node-style callback called with the error, if any, and StorageObject
Returns
Type Description
void

composeObject(request)

public composeObject(request: google.storage.v2.IComposeObjectRequest): Promise<google.storage.v2.StorageObject>;

Calls ComposeObject.

Parameter
Name Description
request IComposeObjectRequest

ComposeObjectRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.StorageObject>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Storage;

Creates new Storage service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
Storage

RPC service. Useful where requests and/or responses are streamed.

createBucket(request, callback)

public createBucket(request: google.storage.v2.ICreateBucketRequest, callback: google.storage.v2.Storage.CreateBucketCallback): void;

Calls CreateBucket.

Parameters
Name Description
request ICreateBucketRequest

CreateBucketRequest message or plain object
callback CreateBucketCallback

Node-style callback called with the error, if any, and Bucket
Returns
Type Description
void

createBucket(request)

public createBucket(request: google.storage.v2.ICreateBucketRequest): Promise<google.storage.v2.Bucket>;

Calls CreateBucket.

Parameter
Name Description
request ICreateBucketRequest

CreateBucketRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.Bucket>

Promise

deleteBucket(request, callback)

public deleteBucket(request: google.storage.v2.IDeleteBucketRequest, callback: google.storage.v2.Storage.DeleteBucketCallback): void;

Calls DeleteBucket.

Parameters
Name Description
request IDeleteBucketRequest

DeleteBucketRequest message or plain object
callback DeleteBucketCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteBucket(request)

public deleteBucket(request: google.storage.v2.IDeleteBucketRequest): Promise<google.protobuf.Empty>;

Calls DeleteBucket.

Parameter
Name Description
request IDeleteBucketRequest

DeleteBucketRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteObject(request, callback)

public deleteObject(request: google.storage.v2.IDeleteObjectRequest, callback: google.storage.v2.Storage.DeleteObjectCallback): void;

Calls DeleteObject.

Parameters
Name Description
request IDeleteObjectRequest

DeleteObjectRequest message or plain object
callback DeleteObjectCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteObject(request)

public deleteObject(request: google.storage.v2.IDeleteObjectRequest): Promise<google.protobuf.Empty>;

Calls DeleteObject.

Parameter
Name Description
request IDeleteObjectRequest

DeleteObjectRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

getBucket(request, callback)

public getBucket(request: google.storage.v2.IGetBucketRequest, callback: google.storage.v2.Storage.GetBucketCallback): void;

Calls GetBucket.

Parameters
Name Description
request IGetBucketRequest

GetBucketRequest message or plain object
callback GetBucketCallback

Node-style callback called with the error, if any, and Bucket
Returns
Type Description
void

getBucket(request)

public getBucket(request: google.storage.v2.IGetBucketRequest): Promise<google.storage.v2.Bucket>;

Calls GetBucket.

Parameter
Name Description
request IGetBucketRequest

GetBucketRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.Bucket>

Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.storage.v2.Storage.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters
Name Description
request IGetIamPolicyRequest

GetIamPolicyRequest message or plain object
callback GetIamPolicyCallback

Node-style callback called with the error, if any, and Policy
Returns
Type Description
void

getIamPolicy(request)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls GetIamPolicy.

Parameter
Name Description
request IGetIamPolicyRequest

GetIamPolicyRequest message or plain object
Returns
Type Description
Promise<google.iam.v1.Policy>

Promise

getObject(request, callback)

public getObject(request: google.storage.v2.IGetObjectRequest, callback: google.storage.v2.Storage.GetObjectCallback): void;

Calls GetObject.

Parameters
Name Description
request IGetObjectRequest

GetObjectRequest message or plain object
callback GetObjectCallback

Node-style callback called with the error, if any, and StorageObject
Returns
Type Description
void

getObject(request)

public getObject(request: google.storage.v2.IGetObjectRequest): Promise<google.storage.v2.StorageObject>;

Calls GetObject.

Parameter
Name Description
request IGetObjectRequest

GetObjectRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.StorageObject>

Promise

listBuckets(request, callback)

public listBuckets(request: google.storage.v2.IListBucketsRequest, callback: google.storage.v2.Storage.ListBucketsCallback): void;

Calls ListBuckets.

Parameters
Name Description
request IListBucketsRequest

ListBucketsRequest message or plain object
callback ListBucketsCallback

Node-style callback called with the error, if any, and ListBucketsResponse
Returns
Type Description
void

listBuckets(request)

public listBuckets(request: google.storage.v2.IListBucketsRequest): Promise<google.storage.v2.ListBucketsResponse>;

Calls ListBuckets.

Parameter
Name Description
request IListBucketsRequest

ListBucketsRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.ListBucketsResponse>

Promise

listObjects(request, callback)

public listObjects(request: google.storage.v2.IListObjectsRequest, callback: google.storage.v2.Storage.ListObjectsCallback): void;

Calls ListObjects.

Parameters
Name Description
request IListObjectsRequest

ListObjectsRequest message or plain object
callback ListObjectsCallback

Node-style callback called with the error, if any, and ListObjectsResponse
Returns
Type Description
void

listObjects(request)

public listObjects(request: google.storage.v2.IListObjectsRequest): Promise<google.storage.v2.ListObjectsResponse>;

Calls ListObjects.

Parameter
Name Description
request IListObjectsRequest

ListObjectsRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.ListObjectsResponse>

Promise

lockBucketRetentionPolicy(request, callback)

public lockBucketRetentionPolicy(request: google.storage.v2.ILockBucketRetentionPolicyRequest, callback: google.storage.v2.Storage.LockBucketRetentionPolicyCallback): void;

Calls LockBucketRetentionPolicy.

Parameters
Name Description
request ILockBucketRetentionPolicyRequest

LockBucketRetentionPolicyRequest message or plain object
callback LockBucketRetentionPolicyCallback

Node-style callback called with the error, if any, and Bucket
Returns
Type Description
void

lockBucketRetentionPolicy(request)

public lockBucketRetentionPolicy(request: google.storage.v2.ILockBucketRetentionPolicyRequest): Promise<google.storage.v2.Bucket>;

Calls LockBucketRetentionPolicy.

Parameter
Name Description
request ILockBucketRetentionPolicyRequest

LockBucketRetentionPolicyRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.Bucket>

Promise

moveObject(request, callback)

public moveObject(request: google.storage.v2.IMoveObjectRequest, callback: google.storage.v2.Storage.MoveObjectCallback): void;

Calls MoveObject.

Parameters
Name Description
request IMoveObjectRequest

MoveObjectRequest message or plain object
callback MoveObjectCallback

Node-style callback called with the error, if any, and StorageObject
Returns
Type Description
void

moveObject(request)

public moveObject(request: google.storage.v2.IMoveObjectRequest): Promise<google.storage.v2.StorageObject>;

Calls MoveObject.

Parameter
Name Description
request IMoveObjectRequest

MoveObjectRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.StorageObject>

Promise

queryWriteStatus(request, callback)

public queryWriteStatus(request: google.storage.v2.IQueryWriteStatusRequest, callback: google.storage.v2.Storage.QueryWriteStatusCallback): void;

Calls QueryWriteStatus.

Parameters
Name Description
request IQueryWriteStatusRequest

QueryWriteStatusRequest message or plain object
callback QueryWriteStatusCallback

Node-style callback called with the error, if any, and QueryWriteStatusResponse
Returns
Type Description
void

queryWriteStatus(request)

public queryWriteStatus(request: google.storage.v2.IQueryWriteStatusRequest): Promise<google.storage.v2.QueryWriteStatusResponse>;

Calls QueryWriteStatus.

Parameter
Name Description
request IQueryWriteStatusRequest

QueryWriteStatusRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.QueryWriteStatusResponse>

Promise

readObject(request, callback)

public readObject(request: google.storage.v2.IReadObjectRequest, callback: google.storage.v2.Storage.ReadObjectCallback): void;

Calls ReadObject.

Parameters
Name Description
request IReadObjectRequest

ReadObjectRequest message or plain object
callback ReadObjectCallback

Node-style callback called with the error, if any, and ReadObjectResponse
Returns
Type Description
void

readObject(request)

public readObject(request: google.storage.v2.IReadObjectRequest): Promise<google.storage.v2.ReadObjectResponse>;

Calls ReadObject.

Parameter
Name Description
request IReadObjectRequest

ReadObjectRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.ReadObjectResponse>

Promise

restoreObject(request, callback)

public restoreObject(request: google.storage.v2.IRestoreObjectRequest, callback: google.storage.v2.Storage.RestoreObjectCallback): void;

Calls RestoreObject.

Parameters
Name Description
request IRestoreObjectRequest

RestoreObjectRequest message or plain object
callback RestoreObjectCallback

Node-style callback called with the error, if any, and StorageObject
Returns
Type Description
void

restoreObject(request)

public restoreObject(request: google.storage.v2.IRestoreObjectRequest): Promise<google.storage.v2.StorageObject>;

Calls RestoreObject.

Parameter
Name Description
request IRestoreObjectRequest

RestoreObjectRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.StorageObject>

Promise

rewriteObject(request, callback)

public rewriteObject(request: google.storage.v2.IRewriteObjectRequest, callback: google.storage.v2.Storage.RewriteObjectCallback): void;

Calls RewriteObject.

Parameters
Name Description
request IRewriteObjectRequest

RewriteObjectRequest message or plain object
callback RewriteObjectCallback

Node-style callback called with the error, if any, and RewriteResponse
Returns
Type Description
void

rewriteObject(request)

public rewriteObject(request: google.storage.v2.IRewriteObjectRequest): Promise<google.storage.v2.RewriteResponse>;

Calls RewriteObject.

Parameter
Name Description
request IRewriteObjectRequest

RewriteObjectRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.RewriteResponse>

Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.storage.v2.Storage.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters
Name Description
request ISetIamPolicyRequest

SetIamPolicyRequest message or plain object
callback SetIamPolicyCallback

Node-style callback called with the error, if any, and Policy
Returns
Type Description
void

setIamPolicy(request)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls SetIamPolicy.

Parameter
Name Description
request ISetIamPolicyRequest

SetIamPolicyRequest message or plain object
Returns
Type Description
Promise<google.iam.v1.Policy>

Promise

startResumableWrite(request, callback)

public startResumableWrite(request: google.storage.v2.IStartResumableWriteRequest, callback: google.storage.v2.Storage.StartResumableWriteCallback): void;

Calls StartResumableWrite.

Parameters
Name Description
request IStartResumableWriteRequest

StartResumableWriteRequest message or plain object
callback StartResumableWriteCallback

Node-style callback called with the error, if any, and StartResumableWriteResponse
Returns
Type Description
void

startResumableWrite(request)

public startResumableWrite(request: google.storage.v2.IStartResumableWriteRequest): Promise<google.storage.v2.StartResumableWriteResponse>;

Calls StartResumableWrite.

Parameter
Name Description
request IStartResumableWriteRequest

StartResumableWriteRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.StartResumableWriteResponse>

Promise

testIamPermissions(request, callback)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.storage.v2.Storage.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters
Name Description
request ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object
callback TestIamPermissionsCallback

Node-style callback called with the error, if any, and TestIamPermissionsResponse
Returns
Type Description
void

testIamPermissions(request)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;

Calls TestIamPermissions.

Parameter
Name Description
request ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object
Returns
Type Description
Promise<google.iam.v1.TestIamPermissionsResponse>

Promise

updateBucket(request, callback)

public updateBucket(request: google.storage.v2.IUpdateBucketRequest, callback: google.storage.v2.Storage.UpdateBucketCallback): void;

Calls UpdateBucket.

Parameters
Name Description
request IUpdateBucketRequest

UpdateBucketRequest message or plain object
callback UpdateBucketCallback

Node-style callback called with the error, if any, and Bucket
Returns
Type Description
void

updateBucket(request)

public updateBucket(request: google.storage.v2.IUpdateBucketRequest): Promise<google.storage.v2.Bucket>;

Calls UpdateBucket.

Parameter
Name Description
request IUpdateBucketRequest

UpdateBucketRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.Bucket>

Promise

updateObject(request, callback)

public updateObject(request: google.storage.v2.IUpdateObjectRequest, callback: google.storage.v2.Storage.UpdateObjectCallback): void;

Calls UpdateObject.

Parameters
Name Description
request IUpdateObjectRequest

UpdateObjectRequest message or plain object
callback UpdateObjectCallback

Node-style callback called with the error, if any, and StorageObject
Returns
Type Description
void

updateObject(request)

public updateObject(request: google.storage.v2.IUpdateObjectRequest): Promise<google.storage.v2.StorageObject>;

Calls UpdateObject.

Parameter
Name Description
request IUpdateObjectRequest

UpdateObjectRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.StorageObject>

Promise

writeObject(request, callback)

public writeObject(request: google.storage.v2.IWriteObjectRequest, callback: google.storage.v2.Storage.WriteObjectCallback): void;

Calls WriteObject.

Parameters
Name Description
request IWriteObjectRequest

WriteObjectRequest message or plain object
callback WriteObjectCallback

Node-style callback called with the error, if any, and WriteObjectResponse
Returns
Type Description
void

writeObject(request)

public writeObject(request: google.storage.v2.IWriteObjectRequest): Promise<google.storage.v2.WriteObjectResponse>;

Calls WriteObject.

Parameter
Name Description
request IWriteObjectRequest

WriteObjectRequest message or plain object
Returns
Type Description
Promise<google.storage.v2.WriteObjectResponse>

Promise