Globals

Abstract types

AddAclCallback

AddAclCallback(err, acl, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

acl

object

The Acl Objects.

apiResponse

object

The full API response.

AddAclResponse

array

Properties

Parameter

0

object

The Acl Objects.

1

object

The full API response.

ClientConfig

object

Properties

Parameter

projectId

Optional

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

keyFilename

Optional

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option above is not necessary. NOTE: .pem and .p12 require you to specify the email option as well.

email

Optional

string

Account email address. Required when using a .pem or .p12 keyFilename.

credentials

Optional

object

Credentials object.

Values in credentials have the following properties:

Parameter

client_email

Optional

string

private_key

Optional

string

autoRetry

Optional

boolean

Automatically retry requests if the response is related to rate limits or certain intermittent server errors. We will exponentially backoff subsequent requests by default.

maxRetries

Optional

number

Maximum number of automatic retries attempted before returning the error.

promise

Optional

Constructor

Custom promise module to use instead of native Promises.

CopyCallback

CopyCallback(err, copiedFile, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

copiedFile

File

The copied File.

apiResponse

object

The full API response.

DeleteNotificationResponse

array

Property

Parameter

0

object

The full API response.

GetAclCallback

GetAclCallback(err, acl, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

acl

(object or Array of object)

Single or array of Acl Objects.

apiResponse

object

The full API response.

GetAclResponse

array

Properties

Parameter

0

(object or Array of object)

Single or array of Acl Objects.

1

object

The full API response.

GetBucketsCallback

GetBucketsCallback(err, buckets)

Parameter

err

Error

Request error, if any.

Value may be null.

buckets

Array of Bucket

Array of Bucket instances.

GetBucketsRequest

object

Query object for listing buckets.

Properties

Parameter

autoPaginate

Optional

boolean

Have pagination handled automatically.

maxApiCalls

Optional

number

Maximum number of API calls to make.

maxResults

Optional

number

Maximum number of items plus prefixes to return.

pageToken

Optional

string

A previously-returned page token representing part of the larger set of results to view.

userProject

Optional

string

The ID of the project which will be billed for the request.

GetBucketsResponse

array

Property

Parameter

0

Array of Bucket

Array of Bucket instances.

GetExpirationDateCallback

GetExpirationDateCallback(err, expirationDate)

Parameter

err

Error

Request error, if any.

Value may be null.

expirationDate

date

A Date object representing the earliest time this file's retention policy will expire.

GetExpirationDateResponse

array

Property

Parameter

0

date

A Date object representing the earliest time this file's retention policy will expire.

GetFileMetadataCallback

GetFileMetadataCallback(err, metadata, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

metadata

object

The File metadata.

apiResponse

object

The full API response.

GetFileMetadataResponse

array

Properties

Parameter

0

object

The File metadata.

1

object

The full API response.

GetFilesResponse

array

Property

Parameter

0

Array of File

Array of File instances.

GetServiceAccountCallback

GetServiceAccountCallback(err, serviceAccount, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

serviceAccount

object

The serviceAccount resource.

Values in serviceAccount have the following properties:

Parameter

emailAddress

string

The service account email address.

apiResponse

object

The full API response.

GetServiceAccountResponse

array

Properties

Parameter

0

object

The service account resource.

1

object

The full API response.

GetSignedPolicyCallback

GetSignedPolicyCallback(err, policy)

Parameter

err

Error

Request error, if any.

Value may be null.

policy

object

The document policy.

GetSignedPolicyResponse

array

Property

Parameter

0

object

The document policy.

MakeFilePublicCallback

MakeFilePublicCallback(err, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

apiResponse

object

The full API response.

NotificationExistsCallback

NotificationExistsCallback(err, exists)

Parameter

err

Error

Request error, if any.

Value may be null.

exists

boolean

Whether the notification exists or not.

NotificationExistsResponse

array

Property

Parameter

0

boolean

Whether the notification exists or not.

RemoveAclCallback

RemoveAclCallback(err, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

apiResponse

object

The full API response.

RemoveAclResponse

array

Property

Parameter

0

object

The full API response.

StopResponse

array

Property

Parameter

0

object

The full API response.

UpdateAclCallback

UpdateAclCallback(err, acl, apiResponse)

Parameter

err

Error

Request error, if any.

Value may be null.

acl

object

The updated Acl Objects.

apiResponse

object

The full API response.

UpdateAclResponse

array

Properties

Parameter

0

object

The updated Acl Objects.

1

object

The full API response.