ObjectsResource class

Constructors

ObjectsResource(ApiRequester client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

bulkRestore(BulkRestoreObjectsRequest request, String bucket, {String? $fields}) → Future<GoogleLongrunningOperation>

Initiates a long-running bulk restore operation on the specified bucket.

compose(ComposeRequest request, String destinationBucket, String destinationObject, {String? destinationPredefinedAcl, String? ifGenerationMatch, String? ifMetagenerationMatch, String? kmsKeyName, String? userProject, String? $fields}) → Future<Object>

Concatenates a list of existing objects into a new object in the same bucket.

copy(Object request, String sourceBucket, String sourceObject, String destinationBucket, String destinationObject, {String? destinationKmsKeyName, String? destinationPredefinedAcl, String? ifGenerationMatch, String? ifGenerationNotMatch, String? ifMetagenerationMatch, String? ifMetagenerationNotMatch, String? ifSourceGenerationMatch, String? ifSourceGenerationNotMatch, String? ifSourceMetagenerationMatch, String? ifSourceMetagenerationNotMatch, String? projection, String? sourceGeneration, String? userProject, String? $fields}) → Future<Object>

Copies a source object to a destination object.

delete(String bucket, String object, {String? generation, String? ifGenerationMatch, String? ifGenerationNotMatch, String? ifMetagenerationMatch, String? ifMetagenerationNotMatch, String? userProject, String? $fields}) → Future<void>

Deletes an object and its metadata.

get(String bucket, String object, {String? generation, String? ifGenerationMatch, String? ifGenerationNotMatch, String? ifMetagenerationMatch, String? ifMetagenerationNotMatch, String? projection, String? restoreToken, bool? softDeleted, String? userProject, String? $fields, DownloadOptions downloadOptions = commons.DownloadOptions.metadata}) → Future<Object>

Retrieves an object or its metadata.

getIamPolicy(String bucket, String object, {String? generation, String? userProject, String? $fields}) → Future<Policy>

Returns an IAM policy for the specified object.

insert(Object request, String bucket, {String? contentEncoding, String? ifGenerationMatch, String? ifGenerationNotMatch, String? ifMetagenerationMatch, String? ifMetagenerationNotMatch, String? kmsKeyName, String? name, String? predefinedAcl, String? projection, String? userProject, String? $fields, UploadOptions uploadOptions = commons.UploadOptions.defaultOptions, Media? uploadMedia}) → Future<Object>

Stores a new object and metadata.

list(String bucket, {String? delimiter, String? endOffset, String? filter, bool? includeFoldersAsPrefixes, bool? includeTrailingDelimiter, String? matchGlob, int? maxResults, String? pageToken, String? prefix, String? projection, bool? softDeleted, String? startOffset, String? userProject, bool? versions, String? $fields}) → Future<Objects>

Retrieves a list of objects matching the criteria.

move(String bucket, String sourceObject, String destinationObject, {String? ifGenerationMatch, String? ifGenerationNotMatch, String? ifMetagenerationMatch, String? ifMetagenerationNotMatch, String? ifSourceGenerationMatch, String? ifSourceGenerationNotMatch, String? ifSourceMetagenerationMatch, String? ifSourceMetagenerationNotMatch, String? projection, String? userProject, String? $fields}) → Future<Object>

Moves the source object to the destination object in the same bucket.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patch(Object request, String bucket, String object, {String? generation, String? ifGenerationMatch, String? ifGenerationNotMatch, String? ifMetagenerationMatch, String? ifMetagenerationNotMatch, bool? overrideUnlockedRetention, String? predefinedAcl, String? projection, String? userProject, String? $fields}) → Future<Object>

Patches an object's metadata.

restore(String bucket, String object, String generation, {bool? copySourceAcl, String? ifGenerationMatch, String? ifGenerationNotMatch, String? ifMetagenerationMatch, String? ifMetagenerationNotMatch, String? projection, String? restoreToken, String? userProject, String? $fields}) → Future<Object>

Restores a soft-deleted object.

rewrite(Object request, String sourceBucket, String sourceObject, String destinationBucket, String destinationObject, {String? destinationKmsKeyName, String? destinationPredefinedAcl, String? ifGenerationMatch, String? ifGenerationNotMatch, String? ifMetagenerationMatch, String? ifMetagenerationNotMatch, String? ifSourceGenerationMatch, String? ifSourceGenerationNotMatch, String? ifSourceMetagenerationMatch, String? ifSourceMetagenerationNotMatch, String? maxBytesRewrittenPerCall, String? projection, String? rewriteToken, String? sourceGeneration, String? userProject, String? $fields}) → Future<RewriteResponse>

Rewrites a source object to a destination object.

setIamPolicy(Policy request, String bucket, String object, {String? generation, String? userProject, String? $fields}) → Future<Policy>

Updates an IAM policy for the specified object.

testIamPermissions(String bucket, String object, List<String> permissions, {String? generation, String? userProject, String? $fields}) → Future<TestIamPermissionsResponse>

Tests a set of permissions on the given object to see which, if any, are held by the caller.

toString() → String

A string representation of this object.

inherited

update(Object request, String bucket, String object, {String? generation, String? ifGenerationMatch, String? ifGenerationNotMatch, String? ifMetagenerationMatch, String? ifMetagenerationNotMatch, bool? overrideUnlockedRetention, String? predefinedAcl, String? projection, String? userProject, String? $fields}) → Future<Object>

Updates an object's metadata.

watchAll(Channel request, String bucket, {String? delimiter, String? endOffset, bool? includeTrailingDelimiter, int? maxResults, String? pageToken, String? prefix, String? projection, String? startOffset, String? userProject, bool? versions, String? $fields}) → Future<Channel>

Watch for changes on all objects in a bucket.

Operators

operator ==(Object other) → bool

The equality operator.

inherited