blob: 3822929381f44331bc88939259d60304e9efe5c7 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/devstorage.full_control": {
"description": "Manage your data and permissions in Google Cloud Storage"
},
"https://www.googleapis.com/auth/devstorage.read_only": {
"description": "View your data in Google Cloud Storage"
},
"https://www.googleapis.com/auth/devstorage.read_write": {
"description": "Manage your data in Google Cloud Storage"
}
}
}
},
"basePath": "/storage/v1/",
"baseUrl": "https://storage.googleapis.com/storage/v1/",
"batchPath": "batch/storage/v1",
"description": "Stores and retrieves potentially large, immutable data objects.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/storage/docs/json_api/",
"etag": "\"32343534393035343133323636313839373339\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/cloud_storage-16.png",
"x32": "https://www.google.com/images/icons/product/cloud_storage-32.png"
},
"id": "storage:v1",
"kind": "discovery#restDescription",
"labels": [
"labs"
],
"name": "storage",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"alt": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query",
"type": "string"
},
"userIp": {
"description": "Deprecated. Please use quotaUser instead.",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"bucketAccessControls": {
"methods": {
"delete": {
"description": "Permanently deletes the ACL entry for the specified entity on the specified bucket.",
"httpMethod": "DELETE",
"id": "storage.bucketAccessControls.delete",
"parameterOrder": [
"bucket",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/acl/{entity}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"get": {
"description": "Returns the ACL entry for the specified entity on the specified bucket.",
"httpMethod": "GET",
"id": "storage.bucketAccessControls.get",
"parameterOrder": [
"bucket",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/acl/{entity}",
"response": {
"$ref": "BucketAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"insert": {
"description": "Creates a new ACL entry on the specified bucket.",
"httpMethod": "POST",
"id": "storage.bucketAccessControls.insert",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/acl",
"request": {
"$ref": "BucketAccessControl"
},
"response": {
"$ref": "BucketAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"list": {
"description": "Retrieves ACL entries on the specified bucket.",
"httpMethod": "GET",
"id": "storage.bucketAccessControls.list",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/acl",
"response": {
"$ref": "BucketAccessControls"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"patch": {
"description": "Patches an ACL entry on the specified bucket.",
"httpMethod": "PATCH",
"id": "storage.bucketAccessControls.patch",
"parameterOrder": [
"bucket",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/acl/{entity}",
"request": {
"$ref": "BucketAccessControl"
},
"response": {
"$ref": "BucketAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"update": {
"description": "Updates an ACL entry on the specified bucket.",
"httpMethod": "PUT",
"id": "storage.bucketAccessControls.update",
"parameterOrder": [
"bucket",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/acl/{entity}",
"request": {
"$ref": "BucketAccessControl"
},
"response": {
"$ref": "BucketAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
}
}
},
"buckets": {
"methods": {
"delete": {
"description": "Permanently deletes an empty bucket.",
"httpMethod": "DELETE",
"id": "storage.buckets.delete",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"ifMetagenerationMatch": {
"description": "If set, only deletes the bucket if its metageneration matches this value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationNotMatch": {
"description": "If set, only deletes the bucket if its metageneration does not match this value.",
"format": "int64",
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"get": {
"description": "Returns metadata for the specified bucket.",
"httpMethod": "GET",
"id": "storage.buckets.get",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"ifMetagenerationMatch": {
"description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationNotMatch": {
"description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"projection": {
"description": "Set of properties to return. Defaults to noAcl.",
"enum": [
"full",
"noAcl"
],
"enumDescriptions": [
"Include all properties.",
"Omit owner, acl and defaultObjectAcl properties."
],
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}",
"response": {
"$ref": "Bucket"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"getIamPolicy": {
"description": "Returns an IAM policy for the specified bucket.",
"httpMethod": "GET",
"id": "storage.buckets.getIamPolicy",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"optionsRequestedPolicyVersion": {
"description": "The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.",
"format": "int32",
"location": "query",
"minimum": "1",
"type": "integer"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/iam",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"insert": {
"description": "Creates a new bucket.",
"httpMethod": "POST",
"id": "storage.buckets.insert",
"parameterOrder": [
"project"
],
"parameters": {
"predefinedAcl": {
"description": "Apply a predefined set of access controls to this bucket.",
"enum": [
"authenticatedRead",
"private",
"projectPrivate",
"publicRead",
"publicReadWrite"
],
"enumDescriptions": [
"Project team owners get OWNER access, and allAuthenticatedUsers get READER access.",
"Project team owners get OWNER access.",
"Project team members get access according to their roles.",
"Project team owners get OWNER access, and allUsers get READER access.",
"Project team owners get OWNER access, and allUsers get WRITER access."
],
"location": "query",
"type": "string"
},
"predefinedDefaultObjectAcl": {
"description": "Apply a predefined set of default object access controls to this bucket.",
"enum": [
"authenticatedRead",
"bucketOwnerFullControl",
"bucketOwnerRead",
"private",
"projectPrivate",
"publicRead"
],
"enumDescriptions": [
"Object owner gets OWNER access, and allAuthenticatedUsers get READER access.",
"Object owner gets OWNER access, and project team owners get OWNER access.",
"Object owner gets OWNER access, and project team owners get READER access.",
"Object owner gets OWNER access.",
"Object owner gets OWNER access, and project team members get access according to their roles.",
"Object owner gets OWNER access, and allUsers get READER access."
],
"location": "query",
"type": "string"
},
"project": {
"description": "A valid API project identifier.",
"location": "query",
"required": true,
"type": "string"
},
"projection": {
"description": "Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.",
"enum": [
"full",
"noAcl"
],
"enumDescriptions": [
"Include all properties.",
"Omit owner, acl and defaultObjectAcl properties."
],
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request.",
"location": "query",
"type": "string"
}
},
"path": "b",
"request": {
"$ref": "Bucket"
},
"response": {
"$ref": "Bucket"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"list": {
"description": "Retrieves a list of buckets for a given project.",
"httpMethod": "GET",
"id": "storage.buckets.list",
"parameterOrder": [
"project"
],
"parameters": {
"maxResults": {
"default": "1000",
"description": "Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"pageToken": {
"description": "A previously-returned page token representing part of the larger set of results to view.",
"location": "query",
"type": "string"
},
"prefix": {
"description": "Filter results to buckets whose names begin with this prefix.",
"location": "query",
"type": "string"
},
"project": {
"description": "A valid API project identifier.",
"location": "query",
"required": true,
"type": "string"
},
"projection": {
"description": "Set of properties to return. Defaults to noAcl.",
"enum": [
"full",
"noAcl"
],
"enumDescriptions": [
"Include all properties.",
"Omit owner, acl and defaultObjectAcl properties."
],
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request.",
"location": "query",
"type": "string"
}
},
"path": "b",
"response": {
"$ref": "Buckets"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"lockRetentionPolicy": {
"description": "Locks retention policy on a bucket.",
"httpMethod": "POST",
"id": "storage.buckets.lockRetentionPolicy",
"parameterOrder": [
"bucket",
"ifMetagenerationMatch"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"ifMetagenerationMatch": {
"description": "Makes the operation conditional on whether bucket's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/lockRetentionPolicy",
"response": {
"$ref": "Bucket"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"patch": {
"description": "Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.",
"httpMethod": "PATCH",
"id": "storage.buckets.patch",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"ifMetagenerationMatch": {
"description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationNotMatch": {
"description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"predefinedAcl": {
"description": "Apply a predefined set of access controls to this bucket.",
"enum": [
"authenticatedRead",
"private",
"projectPrivate",
"publicRead",
"publicReadWrite"
],
"enumDescriptions": [
"Project team owners get OWNER access, and allAuthenticatedUsers get READER access.",
"Project team owners get OWNER access.",
"Project team members get access according to their roles.",
"Project team owners get OWNER access, and allUsers get READER access.",
"Project team owners get OWNER access, and allUsers get WRITER access."
],
"location": "query",
"type": "string"
},
"predefinedDefaultObjectAcl": {
"description": "Apply a predefined set of default object access controls to this bucket.",
"enum": [
"authenticatedRead",
"bucketOwnerFullControl",
"bucketOwnerRead",
"private",
"projectPrivate",
"publicRead"
],
"enumDescriptions": [
"Object owner gets OWNER access, and allAuthenticatedUsers get READER access.",
"Object owner gets OWNER access, and project team owners get OWNER access.",
"Object owner gets OWNER access, and project team owners get READER access.",
"Object owner gets OWNER access.",
"Object owner gets OWNER access, and project team members get access according to their roles.",
"Object owner gets OWNER access, and allUsers get READER access."
],
"location": "query",
"type": "string"
},
"projection": {
"description": "Set of properties to return. Defaults to full.",
"enum": [
"full",
"noAcl"
],
"enumDescriptions": [
"Include all properties.",
"Omit owner, acl and defaultObjectAcl properties."
],
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}",
"request": {
"$ref": "Bucket"
},
"response": {
"$ref": "Bucket"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"setIamPolicy": {
"description": "Updates an IAM policy for the specified bucket.",
"httpMethod": "PUT",
"id": "storage.buckets.setIamPolicy",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/iam",
"request": {
"$ref": "Policy"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"testIamPermissions": {
"description": "Tests a set of permissions on the given bucket to see which, if any, are held by the caller.",
"httpMethod": "GET",
"id": "storage.buckets.testIamPermissions",
"parameterOrder": [
"bucket",
"permissions"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"permissions": {
"description": "Permissions to test.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/iam/testPermissions",
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"update": {
"description": "Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.",
"httpMethod": "PUT",
"id": "storage.buckets.update",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"ifMetagenerationMatch": {
"description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationNotMatch": {
"description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"predefinedAcl": {
"description": "Apply a predefined set of access controls to this bucket.",
"enum": [
"authenticatedRead",
"private",
"projectPrivate",
"publicRead",
"publicReadWrite"
],
"enumDescriptions": [
"Project team owners get OWNER access, and allAuthenticatedUsers get READER access.",
"Project team owners get OWNER access.",
"Project team members get access according to their roles.",
"Project team owners get OWNER access, and allUsers get READER access.",
"Project team owners get OWNER access, and allUsers get WRITER access."
],
"location": "query",
"type": "string"
},
"predefinedDefaultObjectAcl": {
"description": "Apply a predefined set of default object access controls to this bucket.",
"enum": [
"authenticatedRead",
"bucketOwnerFullControl",
"bucketOwnerRead",
"private",
"projectPrivate",
"publicRead"
],
"enumDescriptions": [
"Object owner gets OWNER access, and allAuthenticatedUsers get READER access.",
"Object owner gets OWNER access, and project team owners get OWNER access.",
"Object owner gets OWNER access, and project team owners get READER access.",
"Object owner gets OWNER access.",
"Object owner gets OWNER access, and project team members get access according to their roles.",
"Object owner gets OWNER access, and allUsers get READER access."
],
"location": "query",
"type": "string"
},
"projection": {
"description": "Set of properties to return. Defaults to full.",
"enum": [
"full",
"noAcl"
],
"enumDescriptions": [
"Include all properties.",
"Omit owner, acl and defaultObjectAcl properties."
],
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}",
"request": {
"$ref": "Bucket"
},
"response": {
"$ref": "Bucket"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
}
}
},
"channels": {
"methods": {
"stop": {
"description": "Stop watching resources through this channel",
"httpMethod": "POST",
"id": "storage.channels.stop",
"path": "channels/stop",
"request": {
"$ref": "Channel",
"parameterName": "resource"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
]
}
}
},
"defaultObjectAccessControls": {
"methods": {
"delete": {
"description": "Permanently deletes the default object ACL entry for the specified entity on the specified bucket.",
"httpMethod": "DELETE",
"id": "storage.defaultObjectAccessControls.delete",
"parameterOrder": [
"bucket",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/defaultObjectAcl/{entity}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"get": {
"description": "Returns the default object ACL entry for the specified entity on the specified bucket.",
"httpMethod": "GET",
"id": "storage.defaultObjectAccessControls.get",
"parameterOrder": [
"bucket",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/defaultObjectAcl/{entity}",
"response": {
"$ref": "ObjectAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"insert": {
"description": "Creates a new default object ACL entry on the specified bucket.",
"httpMethod": "POST",
"id": "storage.defaultObjectAccessControls.insert",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/defaultObjectAcl",
"request": {
"$ref": "ObjectAccessControl"
},
"response": {
"$ref": "ObjectAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"list": {
"description": "Retrieves default object ACL entries on the specified bucket.",
"httpMethod": "GET",
"id": "storage.defaultObjectAccessControls.list",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"ifMetagenerationMatch": {
"description": "If present, only return default ACL listing if the bucket's current metageneration matches this value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationNotMatch": {
"description": "If present, only return default ACL listing if the bucket's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/defaultObjectAcl",
"response": {
"$ref": "ObjectAccessControls"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"patch": {
"description": "Patches a default object ACL entry on the specified bucket.",
"httpMethod": "PATCH",
"id": "storage.defaultObjectAccessControls.patch",
"parameterOrder": [
"bucket",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/defaultObjectAcl/{entity}",
"request": {
"$ref": "ObjectAccessControl"
},
"response": {
"$ref": "ObjectAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"update": {
"description": "Updates a default object ACL entry on the specified bucket.",
"httpMethod": "PUT",
"id": "storage.defaultObjectAccessControls.update",
"parameterOrder": [
"bucket",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/defaultObjectAcl/{entity}",
"request": {
"$ref": "ObjectAccessControl"
},
"response": {
"$ref": "ObjectAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
}
}
},
"notifications": {
"methods": {
"delete": {
"description": "Permanently deletes a notification subscription.",
"httpMethod": "DELETE",
"id": "storage.notifications.delete",
"parameterOrder": [
"bucket",
"notification"
],
"parameters": {
"bucket": {
"description": "The parent bucket of the notification.",
"location": "path",
"required": true,
"type": "string"
},
"notification": {
"description": "ID of the notification to delete.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/notificationConfigs/{notification}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"get": {
"description": "View a notification configuration.",
"httpMethod": "GET",
"id": "storage.notifications.get",
"parameterOrder": [
"bucket",
"notification"
],
"parameters": {
"bucket": {
"description": "The parent bucket of the notification.",
"location": "path",
"required": true,
"type": "string"
},
"notification": {
"description": "Notification ID",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/notificationConfigs/{notification}",
"response": {
"$ref": "Notification"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"insert": {
"description": "Creates a notification subscription for a given bucket.",
"httpMethod": "POST",
"id": "storage.notifications.insert",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "The parent bucket of the notification.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/notificationConfigs",
"request": {
"$ref": "Notification"
},
"response": {
"$ref": "Notification"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"list": {
"description": "Retrieves a list of notification subscriptions for a given bucket.",
"httpMethod": "GET",
"id": "storage.notifications.list",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of a Google Cloud Storage bucket.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/notificationConfigs",
"response": {
"$ref": "Notifications"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
]
}
}
},
"objectAccessControls": {
"methods": {
"delete": {
"description": "Permanently deletes the ACL entry for the specified entity on the specified object.",
"httpMethod": "DELETE",
"id": "storage.objectAccessControls.delete",
"parameterOrder": [
"bucket",
"object",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"generation": {
"description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"object": {
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/o/{object}/acl/{entity}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"get": {
"description": "Returns the ACL entry for the specified entity on the specified object.",
"httpMethod": "GET",
"id": "storage.objectAccessControls.get",
"parameterOrder": [
"bucket",
"object",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"generation": {
"description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"object": {
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/o/{object}/acl/{entity}",
"response": {
"$ref": "ObjectAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"insert": {
"description": "Creates a new ACL entry on the specified object.",
"httpMethod": "POST",
"id": "storage.objectAccessControls.insert",
"parameterOrder": [
"bucket",
"object"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"generation": {
"description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"object": {
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/o/{object}/acl",
"request": {
"$ref": "ObjectAccessControl"
},
"response": {
"$ref": "ObjectAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"list": {
"description": "Retrieves ACL entries on the specified object.",
"httpMethod": "GET",
"id": "storage.objectAccessControls.list",
"parameterOrder": [
"bucket",
"object"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"generation": {
"description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"object": {
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/o/{object}/acl",
"response": {
"$ref": "ObjectAccessControls"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"patch": {
"description": "Patches an ACL entry on the specified object.",
"httpMethod": "PATCH",
"id": "storage.objectAccessControls.patch",
"parameterOrder": [
"bucket",
"object",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"generation": {
"description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"object": {
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/o/{object}/acl/{entity}",
"request": {
"$ref": "ObjectAccessControl"
},
"response": {
"$ref": "ObjectAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"update": {
"description": "Updates an ACL entry on the specified object.",
"httpMethod": "PUT",
"id": "storage.objectAccessControls.update",
"parameterOrder": [
"bucket",
"object",
"entity"
],
"parameters": {
"bucket": {
"description": "Name of a bucket.",
"location": "path",
"required": true,
"type": "string"
},
"entity": {
"description": "The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.",
"location": "path",
"required": true,
"type": "string"
},
"generation": {
"description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"object": {
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/o/{object}/acl/{entity}",
"request": {
"$ref": "ObjectAccessControl"
},
"response": {
"$ref": "ObjectAccessControl"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
}
}
},
"objects": {
"methods": {
"compose": {
"description": "Concatenates a list of existing objects into a new object in the same bucket.",
"httpMethod": "POST",
"id": "storage.objects.compose",
"parameterOrder": [
"destinationBucket",
"destinationObject"
],
"parameters": {
"destinationBucket": {
"description": "Name of the bucket containing the source objects. The destination object is stored in this bucket.",
"location": "path",
"required": true,
"type": "string"
},
"destinationObject": {
"description": "Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"destinationPredefinedAcl": {
"description": "Apply a predefined set of access controls to the destination object.",
"enum": [
"authenticatedRead",
"bucketOwnerFullControl",
"bucketOwnerRead",
"private",
"projectPrivate",
"publicRead"
],
"enumDescriptions": [
"Object owner gets OWNER access, and allAuthenticatedUsers get READER access.",
"Object owner gets OWNER access, and project team owners get OWNER access.",
"Object owner gets OWNER access, and project team owners get READER access.",
"Object owner gets OWNER access.",
"Object owner gets OWNER access, and project team members get access according to their roles.",
"Object owner gets OWNER access, and allUsers get READER access."
],
"location": "query",
"type": "string"
},
"ifGenerationMatch": {
"description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationMatch": {
"description": "Makes the operation conditional on whether the object's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"kmsKeyName": {
"description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.",
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{destinationBucket}/o/{destinationObject}/compose",
"request": {
"$ref": "ComposeRequest"
},
"response": {
"$ref": "Object"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"copy": {
"description": "Copies a source object to a destination object. Optionally overrides metadata.",
"httpMethod": "POST",
"id": "storage.objects.copy",
"parameterOrder": [
"sourceBucket",
"sourceObject",
"destinationBucket",
"destinationObject"
],
"parameters": {
"destinationBucket": {
"description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"destinationKmsKeyName": {
"description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.",
"location": "query",
"type": "string"
},
"destinationObject": {
"description": "Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.",
"location": "path",
"required": true,
"type": "string"
},
"destinationPredefinedAcl": {
"description": "Apply a predefined set of access controls to the destination object.",
"enum": [
"authenticatedRead",
"bucketOwnerFullControl",
"bucketOwnerRead",
"private",
"projectPrivate",
"publicRead"
],
"enumDescriptions": [
"Object owner gets OWNER access, and allAuthenticatedUsers get READER access.",
"Object owner gets OWNER access, and project team owners get OWNER access.",
"Object owner gets OWNER access, and project team owners get READER access.",
"Object owner gets OWNER access.",
"Object owner gets OWNER access, and project team members get access according to their roles.",
"Object owner gets OWNER access, and allUsers get READER access."
],
"location": "query",
"type": "string"
},
"ifGenerationMatch": {
"description": "Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifGenerationNotMatch": {
"description": "Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationMatch": {
"description": "Makes the operation conditional on whether the destination object's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationNotMatch": {
"description": "Makes the operation conditional on whether the destination object's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifSourceGenerationMatch": {
"description": "Makes the operation conditional on whether the source object's current generation matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifSourceGenerationNotMatch": {
"description": "Makes the operation conditional on whether the source object's current generation does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifSourceMetagenerationMatch": {
"description": "Makes the operation conditional on whether the source object's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifSourceMetagenerationNotMatch": {
"description": "Makes the operation conditional on whether the source object's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"projection": {
"description": "Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.",
"enum": [
"full",
"noAcl"
],
"enumDescriptions": [
"Include all properties.",
"Omit the owner, acl property."
],
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"sourceBucket": {
"description": "Name of the bucket in which to find the source object.",
"location": "path",
"required": true,
"type": "string"
},
"sourceGeneration": {
"description": "If present, selects a specific revision of the source object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"sourceObject": {
"description": "Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}",
"request": {
"$ref": "Object"
},
"response": {
"$ref": "Object"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"delete": {
"description": "Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.",
"httpMethod": "DELETE",
"id": "storage.objects.delete",
"parameterOrder": [
"bucket",
"object"
],
"parameters": {
"bucket": {
"description": "Name of the bucket in which the object resides.",
"location": "path",
"required": true,
"type": "string"
},
"generation": {
"description": "If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"ifGenerationMatch": {
"description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifGenerationNotMatch": {
"description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationMatch": {
"description": "Makes the operation conditional on whether the object's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationNotMatch": {
"description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"object": {
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/o/{object}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"get": {
"description": "Retrieves an object or its metadata.",
"httpMethod": "GET",
"id": "storage.objects.get",
"parameterOrder": [
"bucket",
"object"
],
"parameters": {
"bucket": {
"description": "Name of the bucket in which the object resides.",
"location": "path",
"required": true,
"type": "string"
},
"generation": {
"description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"ifGenerationMatch": {
"description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifGenerationNotMatch": {
"description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationMatch": {
"description": "Makes the operation conditional on whether the object's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationNotMatch": {
"description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"object": {
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"projection": {
"description": "Set of properties to return. Defaults to noAcl.",
"enum": [
"full",
"noAcl"
],
"enumDescriptions": [
"Include all properties.",
"Omit the owner, acl property."
],
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/o/{object}",
"response": {
"$ref": "Object"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
],
"supportsMediaDownload": true,
"useMediaDownloadService": true
},
"getIamPolicy": {
"description": "Returns an IAM policy for the specified object.",
"httpMethod": "GET",
"id": "storage.objects.getIamPolicy",
"parameterOrder": [
"bucket",
"object"
],
"parameters": {
"bucket": {
"description": "Name of the bucket in which the object resides.",
"location": "path",
"required": true,
"type": "string"
},
"generation": {
"description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"object": {
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/o/{object}/iam",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"insert": {
"description": "Stores a new object and metadata.",
"httpMethod": "POST",
"id": "storage.objects.insert",
"mediaUpload": {
"accept": [
"*/*"
],
"protocols": {
"resumable": {
"multipart": true,
"path": "/resumable/upload/storage/v1/b/{bucket}/o"
},
"simple": {
"multipart": true,
"path": "/upload/storage/v1/b/{bucket}/o"
}
}
},
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.",
"location": "path",
"required": true,
"type": "string"
},
"contentEncoding": {
"description": "If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.",
"location": "query",
"type": "string"
},
"ifGenerationMatch": {
"description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifGenerationNotMatch": {
"description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationMatch": {
"description": "Makes the operation conditional on whether the object's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationNotMatch": {
"description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"kmsKeyName": {
"description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.",
"location": "query",
"type": "string"
},
"name": {
"description": "Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "query",
"type": "string"
},
"predefinedAcl": {
"description": "Apply a predefined set of access controls to this object.",
"enum": [
"authenticatedRead",
"bucketOwnerFullControl",
"bucketOwnerRead",
"private",
"projectPrivate",
"publicRead"
],
"enumDescriptions": [
"Object owner gets OWNER access, and allAuthenticatedUsers get READER access.",
"Object owner gets OWNER access, and project team owners get OWNER access.",
"Object owner gets OWNER access, and project team owners get READER access.",
"Object owner gets OWNER access.",
"Object owner gets OWNER access, and project team members get access according to their roles.",
"Object owner gets OWNER access, and allUsers get READER access."
],
"location": "query",
"type": "string"
},
"projection": {
"description": "Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.",
"enum": [
"full",
"noAcl"
],
"enumDescriptions": [
"Include all properties.",
"Omit the owner, acl property."
],
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/o",
"request": {
"$ref": "Object"
},
"response": {
"$ref": "Object"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_write"
],
"supportsMediaUpload": true
},
"list": {
"description": "Retrieves a list of objects matching the criteria.",
"httpMethod": "GET",
"id": "storage.objects.list",
"parameterOrder": [
"bucket"
],
"parameters": {
"bucket": {
"description": "Name of the bucket in which to look for objects.",
"location": "path",
"required": true,
"type": "string"
},
"delimiter": {
"description": "Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.",
"location": "query",
"type": "string"
},
"endOffset": {
"description": "Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).",
"location": "query",
"type": "string"
},
"includeTrailingDelimiter": {
"description": "If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "1000",
"description": "Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"pageToken": {
"description": "A previously-returned page token representing part of the larger set of results to view.",
"location": "query",
"type": "string"
},
"prefix": {
"description": "Filter results to objects whose names begin with this prefix.",
"location": "query",
"type": "string"
},
"projection": {
"description": "Set of properties to return. Defaults to noAcl.",
"enum": [
"full",
"noAcl"
],
"enumDescriptions": [
"Include all properties.",
"Omit the owner, acl property."
],
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"startOffset": {
"description": "Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
},
"versions": {
"description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.",
"location": "query",
"type": "boolean"
}
},
"path": "b/{bucket}/o",
"response": {
"$ref": "Objects"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
],
"supportsSubscription": true
},
"patch": {
"description": "Patches an object's metadata.",
"httpMethod": "PATCH",
"id": "storage.objects.patch",
"parameterOrder": [
"bucket",
"object"
],
"parameters": {
"bucket": {
"description": "Name of the bucket in which the object resides.",
"location": "path",
"required": true,
"type": "string"
},
"generation": {
"description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"ifGenerationMatch": {
"description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifGenerationNotMatch": {
"description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationMatch": {
"description": "Makes the operation conditional on whether the object's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationNotMatch": {
"description": "Makes the operation conditional on whether the object's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"object": {
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"predefinedAcl": {
"description": "Apply a predefined set of access controls to this object.",
"enum": [
"authenticatedRead",
"bucketOwnerFullControl",
"bucketOwnerRead",
"private",
"projectPrivate",
"publicRead"
],
"enumDescriptions": [
"Object owner gets OWNER access, and allAuthenticatedUsers get READER access.",
"Object owner gets OWNER access, and project team owners get OWNER access.",
"Object owner gets OWNER access, and project team owners get READER access.",
"Object owner gets OWNER access.",
"Object owner gets OWNER access, and project team members get access according to their roles.",
"Object owner gets OWNER access, and allUsers get READER access."
],
"location": "query",
"type": "string"
},
"projection": {
"description": "Set of properties to return. Defaults to full.",
"enum": [
"full",
"noAcl"
],
"enumDescriptions": [
"Include all properties.",
"Omit the owner, acl property."
],
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request, for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{bucket}/o/{object}",
"request": {
"$ref": "Object"
},
"response": {
"$ref": "Object"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control"
]
},
"rewrite": {
"description": "Rewrites a source object to a destination object. Optionally overrides metadata.",
"httpMethod": "POST",
"id": "storage.objects.rewrite",
"parameterOrder": [
"sourceBucket",
"sourceObject",
"destinationBucket",
"destinationObject"
],
"parameters": {
"destinationBucket": {
"description": "Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.",
"location": "path",
"required": true,
"type": "string"
},
"destinationKmsKeyName": {
"description": "Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.",
"location": "query",
"type": "string"
},
"destinationObject": {
"description": "Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"destinationPredefinedAcl": {
"description": "Apply a predefined set of access controls to the destination object.",
"enum": [
"authenticatedRead",
"bucketOwnerFullControl",
"bucketOwnerRead",
"private",
"projectPrivate",
"publicRead"
],
"enumDescriptions": [
"Object owner gets OWNER access, and allAuthenticatedUsers get READER access.",
"Object owner gets OWNER access, and project team owners get OWNER access.",
"Object owner gets OWNER access, and project team owners get READER access.",
"Object owner gets OWNER access.",
"Object owner gets OWNER access, and project team members get access according to their roles.",
"Object owner gets OWNER access, and allUsers get READER access."
],
"location": "query",
"type": "string"
},
"ifGenerationMatch": {
"description": "Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifGenerationNotMatch": {
"description": "Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationMatch": {
"description": "Makes the operation conditional on whether the destination object's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifMetagenerationNotMatch": {
"description": "Makes the operation conditional on whether the destination object's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifSourceGenerationMatch": {
"description": "Makes the operation conditional on whether the source object's current generation matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifSourceGenerationNotMatch": {
"description": "Makes the operation conditional on whether the source object's current generation does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifSourceMetagenerationMatch": {
"description": "Makes the operation conditional on whether the source object's current metageneration matches the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"ifSourceMetagenerationNotMatch": {
"description": "Makes the operation conditional on whether the source object's current metageneration does not match the given value.",
"format": "int64",
"location": "query",
"type": "string"
},
"maxBytesRewrittenPerCall": {
"description": "The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid.",
"format": "int64",
"location": "query",
"type": "string"
},
"projection": {
"description": "Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.",
"enum": [
"full",
"noAcl"
],
"enumDescriptions": [
"Include all properties.",
"Omit the owner, acl property."
],
"location": "query",
"type": "string"
},
"provisionalUserProject": {
"description": "The project to be billed for this request if the target bucket is requester-pays bucket.",
"location": "query",
"type": "string"
},
"rewriteToken": {
"description": "Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.",
"location": "query",
"type": "string"
},
"sourceBucket": {
"description": "Name of the bucket in which to find the source object.",
"location": "path",
"required": true,
"type": "string"
},
"sourceGeneration": {
"description": "If present, selects a specific revision of the source object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"sourceObject": {
"description": "Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"userProject": {
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
"location": "query",
"type": "string"
}
},
"path": "b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}",
"request": {
"$ref": "Object"
},
"response": {
"$ref": "RewriteResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"setIamPolicy": {
"description": "Updates an IAM policy for the specified object.",
"httpMethod": "PUT",
"id": "storage.objects.setIamPolicy",
"parameterOrder": [
"bucket",
"object"
],
"parameters": {
"bucket": {
"description": "Name of the bucket in which the object resides.",
"location": "path",
"required": true,
"type": "string"
},
"generation": {
"description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).",
"format": "int64",
"location": "query",
"type": "string"
},
"object": {
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
"location": "path",
"required": true,
"type": "string"
},
"provisionalUserProject": {