com.google.api.services.storage

Class Storage.Buckets

java.lang.Object

com.google.api.services.storage.Storage.Buckets

Enclosing class:

Storage

public class Storage.Buckets
extends Object

The "buckets" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storage.Buckets.Delete
class	Storage.Buckets.Get
class	Storage.Buckets.GetIamPolicy
class	Storage.Buckets.Insert
class	Storage.Buckets.List
class	Storage.Buckets.LockRetentionPolicy
class	Storage.Buckets.Patch
class	Storage.Buckets.SetIamPolicy
class	Storage.Buckets.TestIamPermissions
class	Storage.Buckets.Update

Constructor Summary

Constructors

Constructor and Description
Buckets()

Method Summary

Modifier and Type	Method and Description
Storage.Buckets.Delete	delete(String bucket) Permanently deletes an empty bucket.
Storage.Buckets.Get	get(String bucket) Returns metadata for the specified bucket.
Storage.Buckets.GetIamPolicy	getIamPolicy(String bucket) Returns an IAM policy for the specified bucket.
Storage.Buckets.Insert	insert(String project, Bucket content) Creates a new bucket.
Storage.Buckets.List	list(String project) Retrieves a list of buckets for a given project.
Storage.Buckets.LockRetentionPolicy	lockRetentionPolicy(String bucket, Long ifMetagenerationMatch) Locks retention policy on a bucket.
Storage.Buckets.Patch	patch(String bucket, Bucket content) Patches a bucket.
Storage.Buckets.SetIamPolicy	setIamPolicy(String bucket, Policy content) Updates an IAM policy for the specified bucket.
Storage.Buckets.TestIamPermissions	testIamPermissions(String bucket, List<String> permissions) Tests a set of permissions on the given bucket to see which, if any, are held by the caller.
Storage.Buckets.Update	update(String bucket, Bucket content) Updates a bucket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Buckets

public Buckets()

Method Detail

delete

public Storage.Buckets.Delete delete(String bucket)
                              throws IOException

Permanently deletes an empty bucket. Create a request for the method "buckets.delete". This request holds the parameters needed by the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

bucket - Name of a bucket.

Returns:

the request

Throws:

IOException

get

public Storage.Buckets.Get get(String bucket)
                        throws IOException

Returns metadata for the specified bucket. Create a request for the method "buckets.get". This request holds the parameters needed by the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

bucket - Name of a bucket.

Returns:

the request

Throws:

IOException

getIamPolicy

public Storage.Buckets.GetIamPolicy getIamPolicy(String bucket)
                                          throws IOException

Returns an IAM policy for the specified bucket. Create a request for the method "buckets.getIamPolicy". This request holds the parameters needed by the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

bucket - Name of a bucket.

Returns:

the request

Throws:

IOException

insert

public Storage.Buckets.Insert insert(String project,
                                     Bucket content)
                              throws IOException

Creates a new bucket. Create a request for the method "buckets.insert". This request holds the parameters needed by the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - A valid API project identifier.

content - the Bucket

Returns:

the request

Throws:

IOException

list

public Storage.Buckets.List list(String project)
                          throws IOException

Retrieves a list of buckets for a given project. Create a request for the method "buckets.list". This request holds the parameters needed by the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - A valid API project identifier.

Returns:

the request

Throws:

IOException

lockRetentionPolicy

public Storage.Buckets.LockRetentionPolicy lockRetentionPolicy(String bucket,
                                                               Long ifMetagenerationMatch)
                                                        throws IOException

Locks retention policy on a bucket. Create a request for the method "buckets.lockRetentionPolicy". This request holds the parameters needed by the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

bucket - Name of a bucket.

ifMetagenerationMatch - Makes the operation conditional on whether bucket's current metageneration matches the given value.

Returns:

the request

Throws:

IOException

patch

public Storage.Buckets.Patch patch(String bucket,
                                   Bucket content)
                            throws IOException

Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. Create a request for the method "buckets.patch". This request holds the parameters needed by the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

bucket - Name of a bucket.

content - the Bucket

Returns:

the request

Throws:

IOException

setIamPolicy

public Storage.Buckets.SetIamPolicy setIamPolicy(String bucket,
                                                 Policy content)
                                          throws IOException

Updates an IAM policy for the specified bucket. Create a request for the method "buckets.setIamPolicy". This request holds the parameters needed by the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

bucket - Name of a bucket.

content - the Policy

Returns:

the request

Throws:

IOException

testIamPermissions

public Storage.Buckets.TestIamPermissions testIamPermissions(String bucket,
                                                             List<String> permissions)
                                                      throws IOException

Tests a set of permissions on the given bucket to see which, if any, are held by the caller. Create a request for the method "buckets.testIamPermissions". This request holds the parameters needed by the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

bucket - Name of a bucket.

permissions - Permissions to test.

Returns:

the request

Throws:

IOException

update

public Storage.Buckets.Update update(String bucket,
                                     Bucket content)
                              throws IOException

Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. Create a request for the method "buckets.update". This request holds the parameters needed by the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

bucket - Name of a bucket.

content - the Bucket

Returns:

the request

Throws:

IOException