Class BucketService

constructor

• new BucketService(sdk: SDKInterface): BucketService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns BucketService

$type

create

• create(
      request: CreateBucketRequest,
  ): Request<CreateBucketRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateBucketRequest

  Returns Request<CreateBucketRequest, Operation<GetOperationRequest>>

• create(
      request: CreateBucketRequest,
      metadata: Metadata,
  ): Request<CreateBucketRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateBucketRequest
  • metadata: Metadata

  Returns Request<CreateBucketRequest, Operation<GetOperationRequest>>

• create(
      request: CreateBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateBucketRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateBucketRequest, Operation<GetOperationRequest>>

• create(
      request: CreateBucketRequest,
  ): Request<CreateBucketRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateBucketRequest

  Returns Request<CreateBucketRequest, Operation<GetOperationRequest>>

• create(
      request: CreateBucketRequest,
      metadata: Metadata,
  ): Request<CreateBucketRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateBucketRequest
  • metadata: Metadata

  Returns Request<CreateBucketRequest, Operation<GetOperationRequest>>

• create(
      request: CreateBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateBucketRequest, Operation<GetOperationRequest>>

  Calls the Create RPC.

  Parameters

  • request: CreateBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateBucketRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteBucketRequest,
  ): Request<DeleteBucketRequest, Operation<GetOperationRequest>>

  Calls the Delete RPC.

  Parameters

  • request: DeleteBucketRequest

  Returns Request<DeleteBucketRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteBucketRequest,
      metadata: Metadata,
  ): Request<DeleteBucketRequest, Operation<GetOperationRequest>>

  Calls the Delete RPC.

  Parameters

  • request: DeleteBucketRequest
  • metadata: Metadata

  Returns Request<DeleteBucketRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteBucketRequest, Operation<GetOperationRequest>>

  Calls the Delete RPC.

  Parameters

  • request: DeleteBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteBucketRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteBucketRequest,
  ): Request<DeleteBucketRequest, Operation<GetOperationRequest>>

  Calls the Delete RPC.

  Parameters

  • request: DeleteBucketRequest

  Returns Request<DeleteBucketRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteBucketRequest,
      metadata: Metadata,
  ): Request<DeleteBucketRequest, Operation<GetOperationRequest>>

  Calls the Delete RPC.

  Parameters

  • request: DeleteBucketRequest
  • metadata: Metadata

  Returns Request<DeleteBucketRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteBucketRequest, Operation<GetOperationRequest>>

  Calls the Delete RPC.

  Parameters

  • request: DeleteBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteBucketRequest, Operation<GetOperationRequest>>

get

• get(request: GetBucketRequest): Request<GetBucketRequest, Bucket>

  Calls the Get RPC.

  Parameters

  • request: GetBucketRequest

  Returns Request<GetBucketRequest, Bucket>

• get(
      request: GetBucketRequest,
      metadata: Metadata,
  ): Request<GetBucketRequest, Bucket>

  Calls the Get RPC.

  Parameters

  • request: GetBucketRequest
  • metadata: Metadata

  Returns Request<GetBucketRequest, Bucket>

• get(
      request: GetBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetBucketRequest, Bucket>

  Calls the Get RPC.

  Parameters

  • request: GetBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetBucketRequest, Bucket>

• get(request: GetBucketRequest): Request<GetBucketRequest, Bucket>

  Calls the Get RPC.

  Parameters

  • request: GetBucketRequest

  Returns Request<GetBucketRequest, Bucket>

• get(
      request: GetBucketRequest,
      metadata: Metadata,
  ): Request<GetBucketRequest, Bucket>

  Calls the Get RPC.

  Parameters

  • request: GetBucketRequest
  • metadata: Metadata

  Returns Request<GetBucketRequest, Bucket>

• get(
      request: GetBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetBucketRequest, Bucket>

  Calls the Get RPC.

  Parameters

  • request: GetBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetBucketRequest, Bucket>

getByName

• getByName(
      request: GetBucketByNameRequest,
  ): Request<GetBucketByNameRequest, Bucket>

  Calls the GetByName RPC.

  Parameters

  • request: GetBucketByNameRequest

  Returns Request<GetBucketByNameRequest, Bucket>

• getByName(
      request: GetBucketByNameRequest,
      metadata: Metadata,
  ): Request<GetBucketByNameRequest, Bucket>

  Calls the GetByName RPC.

  Parameters

  • request: GetBucketByNameRequest
  • metadata: Metadata

  Returns Request<GetBucketByNameRequest, Bucket>

• getByName(
      request: GetBucketByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetBucketByNameRequest, Bucket>

  Calls the GetByName RPC.

  Parameters

  • request: GetBucketByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetBucketByNameRequest, Bucket>

• getByName(
      request: GetBucketByNameRequest,
  ): Request<GetBucketByNameRequest, Bucket>

  Calls the GetByName RPC.

  Parameters

  • request: GetBucketByNameRequest

  Returns Request<GetBucketByNameRequest, Bucket>

• getByName(
      request: GetBucketByNameRequest,
      metadata: Metadata,
  ): Request<GetBucketByNameRequest, Bucket>

  Calls the GetByName RPC.

  Parameters

  • request: GetBucketByNameRequest
  • metadata: Metadata

  Returns Request<GetBucketByNameRequest, Bucket>

• getByName(
      request: GetBucketByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetBucketByNameRequest, Bucket>

  Calls the GetByName RPC.

  Parameters

  • request: GetBucketByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetBucketByNameRequest, Bucket>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListBucketsRequest,
  ): Request<ListBucketsRequest, ListBucketsResponse>

  Calls the List RPC.

  Parameters

  • request: ListBucketsRequest

  Returns Request<ListBucketsRequest, ListBucketsResponse>

• list(
      request: ListBucketsRequest,
      metadata: Metadata,
  ): Request<ListBucketsRequest, ListBucketsResponse>

  Calls the List RPC.

  Parameters

  • request: ListBucketsRequest
  • metadata: Metadata

  Returns Request<ListBucketsRequest, ListBucketsResponse>

• list(
      request: ListBucketsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListBucketsRequest, ListBucketsResponse>

  Calls the List RPC.

  Parameters

  • request: ListBucketsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListBucketsRequest, ListBucketsResponse>

• list(
      request: ListBucketsRequest,
  ): Request<ListBucketsRequest, ListBucketsResponse>

  Calls the List RPC.

  Parameters

  • request: ListBucketsRequest

  Returns Request<ListBucketsRequest, ListBucketsResponse>

• list(
      request: ListBucketsRequest,
      metadata: Metadata,
  ): Request<ListBucketsRequest, ListBucketsResponse>

  Calls the List RPC.

  Parameters

  • request: ListBucketsRequest
  • metadata: Metadata

  Returns Request<ListBucketsRequest, ListBucketsResponse>

• list(
      request: ListBucketsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListBucketsRequest, ListBucketsResponse>

  Calls the List RPC.

  Parameters

  • request: ListBucketsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListBucketsRequest, ListBucketsResponse>

purge

• purge(
      request: PurgeBucketRequest,
  ): Request<PurgeBucketRequest, Operation<GetOperationRequest>>

  Purge instantly deletes the bucket in ScheduledForDeletion state. It can be used only for buckets in ScheduledForDeletion state. If you want to delete Active bucket instantly, use Delete with zero ttl.

  Parameters

  • request: PurgeBucketRequest

  Returns Request<PurgeBucketRequest, Operation<GetOperationRequest>>

• purge(
      request: PurgeBucketRequest,
      metadata: Metadata,
  ): Request<PurgeBucketRequest, Operation<GetOperationRequest>>

  Purge instantly deletes the bucket in ScheduledForDeletion state. It can be used only for buckets in ScheduledForDeletion state. If you want to delete Active bucket instantly, use Delete with zero ttl.

  Parameters

  • request: PurgeBucketRequest
  • metadata: Metadata

  Returns Request<PurgeBucketRequest, Operation<GetOperationRequest>>

• purge(
      request: PurgeBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<PurgeBucketRequest, Operation<GetOperationRequest>>

  Purge instantly deletes the bucket in ScheduledForDeletion state. It can be used only for buckets in ScheduledForDeletion state. If you want to delete Active bucket instantly, use Delete with zero ttl.

  Parameters

  • request: PurgeBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<PurgeBucketRequest, Operation<GetOperationRequest>>

• purge(
      request: PurgeBucketRequest,
  ): Request<PurgeBucketRequest, Operation<GetOperationRequest>>

  Purge instantly deletes the bucket in ScheduledForDeletion state. It can be used only for buckets in ScheduledForDeletion state. If you want to delete Active bucket instantly, use Delete with zero ttl.

  Parameters

  • request: PurgeBucketRequest

  Returns Request<PurgeBucketRequest, Operation<GetOperationRequest>>

• purge(
      request: PurgeBucketRequest,
      metadata: Metadata,
  ): Request<PurgeBucketRequest, Operation<GetOperationRequest>>

  Purge instantly deletes the bucket in ScheduledForDeletion state. It can be used only for buckets in ScheduledForDeletion state. If you want to delete Active bucket instantly, use Delete with zero ttl.

  Parameters

  • request: PurgeBucketRequest
  • metadata: Metadata

  Returns Request<PurgeBucketRequest, Operation<GetOperationRequest>>

• purge(
      request: PurgeBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<PurgeBucketRequest, Operation<GetOperationRequest>>

  Purge instantly deletes the bucket in ScheduledForDeletion state. It can be used only for buckets in ScheduledForDeletion state. If you want to delete Active bucket instantly, use Delete with zero ttl.

  Parameters

  • request: PurgeBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<PurgeBucketRequest, Operation<GetOperationRequest>>

undelete

• undelete(
      request: UndeleteBucketRequest,
  ): Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

  Undelete recovers the bucket from ScheduledForDeletion state to Active.

  Parameters

  • request: UndeleteBucketRequest

  Returns Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteBucketRequest,
      metadata: Metadata,
  ): Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

  Undelete recovers the bucket from ScheduledForDeletion state to Active.

  Parameters

  • request: UndeleteBucketRequest
  • metadata: Metadata

  Returns Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

  Undelete recovers the bucket from ScheduledForDeletion state to Active.

  Parameters

  • request: UndeleteBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteBucketRequest,
  ): Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

  Undelete recovers the bucket from ScheduledForDeletion state to Active.

  Parameters

  • request: UndeleteBucketRequest

  Returns Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteBucketRequest,
      metadata: Metadata,
  ): Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

  Undelete recovers the bucket from ScheduledForDeletion state to Active.

  Parameters

  • request: UndeleteBucketRequest
  • metadata: Metadata

  Returns Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

  Undelete recovers the bucket from ScheduledForDeletion state to Active.

  Parameters

  • request: UndeleteBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UndeleteBucketRequest, Operation<GetOperationRequest>>

update

• update(
      request: UpdateBucketRequest,
  ): Request<UpdateBucketRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateBucketRequest

  Returns Request<UpdateBucketRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateBucketRequest,
      metadata: Metadata,
  ): Request<UpdateBucketRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateBucketRequest
  • metadata: Metadata

  Returns Request<UpdateBucketRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateBucketRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateBucketRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateBucketRequest,
  ): Request<UpdateBucketRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateBucketRequest

  Returns Request<UpdateBucketRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateBucketRequest,
      metadata: Metadata,
  ): Request<UpdateBucketRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateBucketRequest
  • metadata: Metadata

  Returns Request<UpdateBucketRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateBucketRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateBucketRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateBucketRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateBucketRequest, Operation<GetOperationRequest>>