class GoogleCloudStorage::ObjectsApi
- GoogleCloudStorage::ObjectsApi
- Reference
- Object
Defined in:
google_cloud_storage/api/objects_api.crConstant Summary
-
STORAGE_OBJECTS_COMPOSE_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_COMPOSE_VALID_VALUES_FOR_DESTINATION_PREDEFINED_ACL =
String.static_array("authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", "publicRead")
-
STORAGE_OBJECTS_COPY_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_COPY_VALID_VALUES_FOR_DESTINATION_PREDEFINED_ACL =
String.static_array("authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", "publicRead")
-
STORAGE_OBJECTS_COPY_VALID_VALUES_FOR_PROJECTION =
String.static_array("full", "noAcl")
-
STORAGE_OBJECTS_DELETE_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_GET_IAM_POLICY_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_GET_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_GET_VALID_VALUES_FOR_PROJECTION =
String.static_array("full", "noAcl")
-
STORAGE_OBJECTS_INSERT_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_INSERT_VALID_VALUES_FOR_PREDEFINED_ACL =
String.static_array("authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", "publicRead")
-
STORAGE_OBJECTS_INSERT_VALID_VALUES_FOR_PROJECTION =
String.static_array("full", "noAcl")
-
STORAGE_OBJECTS_LIST_MIN_FOR_MAX_RESULTS =
Int32.new("0")
-
STORAGE_OBJECTS_LIST_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_LIST_VALID_VALUES_FOR_PROJECTION =
String.static_array("full", "noAcl")
-
STORAGE_OBJECTS_PATCH_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_PATCH_VALID_VALUES_FOR_PREDEFINED_ACL =
String.static_array("authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", "publicRead")
-
STORAGE_OBJECTS_PATCH_VALID_VALUES_FOR_PROJECTION =
String.static_array("full", "noAcl")
-
STORAGE_OBJECTS_REWRITE_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_REWRITE_VALID_VALUES_FOR_DESTINATION_PREDEFINED_ACL =
String.static_array("authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", "publicRead")
-
STORAGE_OBJECTS_REWRITE_VALID_VALUES_FOR_PROJECTION =
String.static_array("full", "noAcl")
-
STORAGE_OBJECTS_SET_IAM_POLICY_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_TEST_IAM_PERMISSIONS_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_UPDATE_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_UPDATE_VALID_VALUES_FOR_PREDEFINED_ACL =
String.static_array("authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", "publicRead")
-
STORAGE_OBJECTS_UPDATE_VALID_VALUES_FOR_PROJECTION =
String.static_array("full", "noAcl")
-
STORAGE_OBJECTS_WATCH_ALL_MIN_FOR_MAX_RESULTS =
Int32.new("0")
-
STORAGE_OBJECTS_WATCH_ALL_VALID_VALUES_FOR_ALT =
String.static_array("json", "media")
-
STORAGE_OBJECTS_WATCH_ALL_VALID_VALUES_FOR_PROJECTION =
String.static_array("full", "noAcl")
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_compose(*, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, kms_key_name : String | Nil = nil, user_project : String | Nil = nil, compose_request : GoogleCloudStorage::ComposeRequest | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_copy(*, source_bucket : String | Nil = nil, source_object : String | Nil = nil, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_kms_key_name : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, if_source_generation_match : String | Nil = nil, if_source_generation_not_match : String | Nil = nil, if_source_metageneration_match : String | Nil = nil, if_source_metageneration_not_match : String | Nil = nil, projection : String | Nil = nil, source_generation : String | Nil = nil, user_project : String | Nil = nil, object : GoogleCloudStorage::Object | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_delete(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, user_project : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_iam_policy(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_insert(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, content_encoding : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, kms_key_name : String | Nil = nil, name : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, body : IO | String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, delimiter : String | Nil = nil, end_offset : String | Nil = nil, include_trailing_delimiter : Bool | Nil = nil, max_results : Int32 | Nil = nil, page_token : String | Nil = nil, prefix : String | Nil = nil, projection : String | Nil = nil, start_offset : String | Nil = nil, user_project : String | Nil = nil, versions : Bool | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_patch(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, object2 : GoogleCloudStorage::Object | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_rewrite(*, source_bucket : String | Nil = nil, source_object : String | Nil = nil, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_kms_key_name : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, if_source_generation_match : String | Nil = nil, if_source_generation_not_match : String | Nil = nil, if_source_metageneration_match : String | Nil = nil, if_source_metageneration_not_match : String | Nil = nil, max_bytes_rewritten_per_call : String | Nil = nil, projection : String | Nil = nil, rewrite_token : String | Nil = nil, source_generation : String | Nil = nil, user_project : String | Nil = nil, object : GoogleCloudStorage::Object | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_set_iam_policy(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil, policy : GoogleCloudStorage::Policy | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_test_iam_permissions(*, bucket : String | Nil = nil, object : String | Nil = nil, permissions : Array(String) | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_update(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, object2 : GoogleCloudStorage::Object | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_watch_all(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, delimiter : String | Nil = nil, end_offset : String | Nil = nil, include_trailing_delimiter : Bool | Nil = nil, max_results : Int32 | Nil = nil, page_token : String | Nil = nil, prefix : String | Nil = nil, projection : String | Nil = nil, start_offset : String | Nil = nil, user_project : String | Nil = nil, versions : Bool | Nil = nil, channel : GoogleCloudStorage::Channel | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
-
#compose(*, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, kms_key_name : String | Nil = nil, user_project : String | Nil = nil, compose_request : GoogleCloudStorage::ComposeRequest | Nil = nil) : GoogleCloudStorage::Object
Concatenates a list of existing objects into a new object in the same bucket.
-
#compose(*, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, kms_key_name : String | Nil = nil, user_project : String | Nil = nil, compose_request : GoogleCloudStorage::ComposeRequest | Nil = nil, &block : Crest::Response -> ) : Nil
Concatenates a list of existing objects into a new object in the same bucket.
-
#compose_with_http_info(*, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, kms_key_name : String | Nil = nil, user_project : String | Nil = nil, compose_request : GoogleCloudStorage::ComposeRequest | Nil = nil) : Tuple(GoogleCloudStorage::Object, Int32, Hash(String, Array(String) | String))
Concatenates a list of existing objects into a new object in the same bucket.
-
#copy(*, source_bucket : String | Nil = nil, source_object : String | Nil = nil, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_kms_key_name : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, if_source_generation_match : String | Nil = nil, if_source_generation_not_match : String | Nil = nil, if_source_metageneration_match : String | Nil = nil, if_source_metageneration_not_match : String | Nil = nil, projection : String | Nil = nil, source_generation : String | Nil = nil, user_project : String | Nil = nil, object : GoogleCloudStorage::Object | Nil = nil) : GoogleCloudStorage::Object
Copies a source object to a destination object.
-
#copy(*, source_bucket : String | Nil = nil, source_object : String | Nil = nil, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_kms_key_name : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, if_source_generation_match : String | Nil = nil, if_source_generation_not_match : String | Nil = nil, if_source_metageneration_match : String | Nil = nil, if_source_metageneration_not_match : String | Nil = nil, projection : String | Nil = nil, source_generation : String | Nil = nil, user_project : String | Nil = nil, object : GoogleCloudStorage::Object | Nil = nil, &block : Crest::Response -> ) : Nil
Copies a source object to a destination object.
-
#copy_with_http_info(*, source_bucket : String | Nil = nil, source_object : String | Nil = nil, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_kms_key_name : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, if_source_generation_match : String | Nil = nil, if_source_generation_not_match : String | Nil = nil, if_source_metageneration_match : String | Nil = nil, if_source_metageneration_not_match : String | Nil = nil, projection : String | Nil = nil, source_generation : String | Nil = nil, user_project : String | Nil = nil, object : GoogleCloudStorage::Object | Nil = nil) : Tuple(GoogleCloudStorage::Object, Int32, Hash(String, Array(String) | String))
Copies a source object to a destination object.
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#delete(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, user_project : String | Nil = nil) : Nil
Deletes an object and its metadata.
-
#delete(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, user_project : String | Nil = nil, &block : Crest::Response -> ) : Nil
Deletes an object and its metadata.
-
#delete_with_http_info(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, user_project : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String))
Deletes an object and its metadata.
-
#get(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil) : GoogleCloudStorage::Object
Retrieves an object or its metadata.
-
#get(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieves an object or its metadata.
-
#get_iam_policy(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil) : GoogleCloudStorage::Policy
Returns an IAM policy for the specified object.
-
#get_iam_policy(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil, &block : Crest::Response -> ) : Nil
Returns an IAM policy for the specified object.
-
#get_iam_policy_with_http_info(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil) : Tuple(GoogleCloudStorage::Policy, Int32, Hash(String, Array(String) | String))
Returns an IAM policy for the specified object.
-
#get_with_http_info(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil) : Tuple(GoogleCloudStorage::Object, Int32, Hash(String, Array(String) | String))
Retrieves an object or its metadata.
-
#insert(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, content_encoding : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, kms_key_name : String | Nil = nil, name : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, body : IO | String | Nil = nil) : GoogleCloudStorage::Object
Stores a new object and metadata.
-
#insert(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, content_encoding : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, kms_key_name : String | Nil = nil, name : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, body : IO | String | Nil = nil, &block : Crest::Response -> ) : Nil
Stores a new object and metadata.
-
#insert_with_http_info(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, content_encoding : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, kms_key_name : String | Nil = nil, name : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, body : IO | String | Nil = nil) : Tuple(GoogleCloudStorage::Object, Int32, Hash(String, Array(String) | String))
Stores a new object and metadata.
-
#list(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, delimiter : String | Nil = nil, end_offset : String | Nil = nil, include_trailing_delimiter : Bool | Nil = nil, max_results : Int32 | Nil = nil, page_token : String | Nil = nil, prefix : String | Nil = nil, projection : String | Nil = nil, start_offset : String | Nil = nil, user_project : String | Nil = nil, versions : Bool | Nil = nil) : GoogleCloudStorage::Objects
Retrieves a list of objects matching the criteria.
-
#list(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, delimiter : String | Nil = nil, end_offset : String | Nil = nil, include_trailing_delimiter : Bool | Nil = nil, max_results : Int32 | Nil = nil, page_token : String | Nil = nil, prefix : String | Nil = nil, projection : String | Nil = nil, start_offset : String | Nil = nil, user_project : String | Nil = nil, versions : Bool | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieves a list of objects matching the criteria.
-
#list_with_http_info(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, delimiter : String | Nil = nil, end_offset : String | Nil = nil, include_trailing_delimiter : Bool | Nil = nil, max_results : Int32 | Nil = nil, page_token : String | Nil = nil, prefix : String | Nil = nil, projection : String | Nil = nil, start_offset : String | Nil = nil, user_project : String | Nil = nil, versions : Bool | Nil = nil) : Tuple(GoogleCloudStorage::Objects, Int32, Hash(String, Array(String) | String))
Retrieves a list of objects matching the criteria.
-
#patch(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, object2 : GoogleCloudStorage::Object | Nil = nil) : GoogleCloudStorage::Object
Patches an object's metadata.
-
#patch(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, object2 : GoogleCloudStorage::Object | Nil = nil, &block : Crest::Response -> ) : Nil
Patches an object's metadata.
-
#patch_with_http_info(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, object2 : GoogleCloudStorage::Object | Nil = nil) : Tuple(GoogleCloudStorage::Object, Int32, Hash(String, Array(String) | String))
Patches an object's metadata.
-
#rewrite(*, source_bucket : String | Nil = nil, source_object : String | Nil = nil, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_kms_key_name : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, if_source_generation_match : String | Nil = nil, if_source_generation_not_match : String | Nil = nil, if_source_metageneration_match : String | Nil = nil, if_source_metageneration_not_match : String | Nil = nil, max_bytes_rewritten_per_call : String | Nil = nil, projection : String | Nil = nil, rewrite_token : String | Nil = nil, source_generation : String | Nil = nil, user_project : String | Nil = nil, object : GoogleCloudStorage::Object | Nil = nil) : GoogleCloudStorage::RewriteResponse
Rewrites a source object to a destination object.
-
#rewrite(*, source_bucket : String | Nil = nil, source_object : String | Nil = nil, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_kms_key_name : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, if_source_generation_match : String | Nil = nil, if_source_generation_not_match : String | Nil = nil, if_source_metageneration_match : String | Nil = nil, if_source_metageneration_not_match : String | Nil = nil, max_bytes_rewritten_per_call : String | Nil = nil, projection : String | Nil = nil, rewrite_token : String | Nil = nil, source_generation : String | Nil = nil, user_project : String | Nil = nil, object : GoogleCloudStorage::Object | Nil = nil, &block : Crest::Response -> ) : Nil
Rewrites a source object to a destination object.
-
#rewrite_with_http_info(*, source_bucket : String | Nil = nil, source_object : String | Nil = nil, destination_bucket : String | Nil = nil, destination_object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, destination_kms_key_name : String | Nil = nil, destination_predefined_acl : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, if_source_generation_match : String | Nil = nil, if_source_generation_not_match : String | Nil = nil, if_source_metageneration_match : String | Nil = nil, if_source_metageneration_not_match : String | Nil = nil, max_bytes_rewritten_per_call : String | Nil = nil, projection : String | Nil = nil, rewrite_token : String | Nil = nil, source_generation : String | Nil = nil, user_project : String | Nil = nil, object : GoogleCloudStorage::Object | Nil = nil) : Tuple(GoogleCloudStorage::RewriteResponse, Int32, Hash(String, Array(String) | String))
Rewrites a source object to a destination object.
-
#set_iam_policy(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil, policy : GoogleCloudStorage::Policy | Nil = nil) : GoogleCloudStorage::Policy
Updates an IAM policy for the specified object.
-
#set_iam_policy(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil, policy : GoogleCloudStorage::Policy | Nil = nil, &block : Crest::Response -> ) : Nil
Updates an IAM policy for the specified object.
-
#set_iam_policy_with_http_info(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil, policy : GoogleCloudStorage::Policy | Nil = nil) : Tuple(GoogleCloudStorage::Policy, Int32, Hash(String, Array(String) | String))
Updates an IAM policy for the specified object.
-
#test_iam_permissions(*, bucket : String | Nil = nil, object : String | Nil = nil, permissions : Array(String) | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil) : GoogleCloudStorage::TestIamPermissionsResponse
Tests a set of permissions on the given object to see which, if any, are held by the caller.
-
#test_iam_permissions(*, bucket : String | Nil = nil, object : String | Nil = nil, permissions : Array(String) | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil, &block : Crest::Response -> ) : Nil
Tests a set of permissions on the given object to see which, if any, are held by the caller.
-
#test_iam_permissions_with_http_info(*, bucket : String | Nil = nil, object : String | Nil = nil, permissions : Array(String) | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, user_project : String | Nil = nil) : Tuple(GoogleCloudStorage::TestIamPermissionsResponse, Int32, Hash(String, Array(String) | String))
Tests a set of permissions on the given object to see which, if any, are held by the caller.
-
#update(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, object2 : GoogleCloudStorage::Object | Nil = nil) : GoogleCloudStorage::Object
Updates an object's metadata.
-
#update(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, object2 : GoogleCloudStorage::Object | Nil = nil, &block : Crest::Response -> ) : Nil
Updates an object's metadata.
-
#update_with_http_info(*, bucket : String | Nil = nil, object : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, generation : String | Nil = nil, if_generation_match : String | Nil = nil, if_generation_not_match : String | Nil = nil, if_metageneration_match : String | Nil = nil, if_metageneration_not_match : String | Nil = nil, predefined_acl : String | Nil = nil, projection : String | Nil = nil, user_project : String | Nil = nil, object2 : GoogleCloudStorage::Object | Nil = nil) : Tuple(GoogleCloudStorage::Object, Int32, Hash(String, Array(String) | String))
Updates an object's metadata.
-
#watch_all(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, delimiter : String | Nil = nil, end_offset : String | Nil = nil, include_trailing_delimiter : Bool | Nil = nil, max_results : Int32 | Nil = nil, page_token : String | Nil = nil, prefix : String | Nil = nil, projection : String | Nil = nil, start_offset : String | Nil = nil, user_project : String | Nil = nil, versions : Bool | Nil = nil, channel : GoogleCloudStorage::Channel | Nil = nil) : GoogleCloudStorage::Channel
Watch for changes on all objects in a bucket.
-
#watch_all(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, delimiter : String | Nil = nil, end_offset : String | Nil = nil, include_trailing_delimiter : Bool | Nil = nil, max_results : Int32 | Nil = nil, page_token : String | Nil = nil, prefix : String | Nil = nil, projection : String | Nil = nil, start_offset : String | Nil = nil, user_project : String | Nil = nil, versions : Bool | Nil = nil, channel : GoogleCloudStorage::Channel | Nil = nil, &block : Crest::Response -> ) : Nil
Watch for changes on all objects in a bucket.
-
#watch_all_with_http_info(*, bucket : String | Nil = nil, alt : String | Nil = nil, fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, upload_type : String | Nil = nil, user_ip : String | Nil = nil, delimiter : String | Nil = nil, end_offset : String | Nil = nil, include_trailing_delimiter : Bool | Nil = nil, max_results : Int32 | Nil = nil, page_token : String | Nil = nil, prefix : String | Nil = nil, projection : String | Nil = nil, start_offset : String | Nil = nil, user_project : String | Nil = nil, versions : Bool | Nil = nil, channel : GoogleCloudStorage::Channel | Nil = nil) : Tuple(GoogleCloudStorage::Channel, Int32, Hash(String, Array(String) | String))
Watch for changes on all objects in a bucket.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Concatenates a list of existing objects into a new object in the same bucket. @required @param destination_bucket [String?] Name of the bucket containing the source objects. The destination object is stored in this bucket. @required @param destination_object [String?] Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param destination_predefined_acl [String?] Apply a predefined set of access controls to the destination object. @optional @param if_generation_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param kms_key_name [String?] 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. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param compose_request [GoogleCloudStorage::ComposeRequest?] @return [GoogleCloudStorage::Object]
Concatenates a list of existing objects into a new object in the same bucket. @required @param destination_bucket [String?] Name of the bucket containing the source objects. The destination object is stored in this bucket. @required @param destination_object [String?] Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param destination_predefined_acl [String?] Apply a predefined set of access controls to the destination object. @optional @param if_generation_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param kms_key_name [String?] 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. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param compose_request [GoogleCloudStorage::ComposeRequest?] @return nil
Concatenates a list of existing objects into a new object in the same bucket. @required @param destination_bucket [String?] Name of the bucket containing the source objects. The destination object is stored in this bucket. @required @param destination_object [String?] Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param destination_predefined_acl [String?] Apply a predefined set of access controls to the destination object. @optional @param if_generation_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param kms_key_name [String?] 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. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param compose_request [GoogleCloudStorage::ComposeRequest?] @return [Tuple(GoogleCloudStorage::Object, Integer, Hash)] GoogleCloudStorage::Object, response status code and response headers
Copies a source object to a destination object. Optionally overrides metadata. @required @param source_bucket [String?] Name of the bucket in which to find the source object. @required @param source_object [String?] Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @required @param destination_bucket [String?] 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. @required @param destination_object [String?] Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param destination_kms_key_name [String?] 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. @optional @param destination_predefined_acl [String?] Apply a predefined set of access controls to the destination object. @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the destination object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the destination object's current metageneration does not match the given value. @optional @param if_source_generation_match [String?] Makes the operation conditional on whether the source object's current generation matches the given value. @optional @param if_source_generation_not_match [String?] Makes the operation conditional on whether the source object's current generation does not match the given value. @optional @param if_source_metageneration_match [String?] Makes the operation conditional on whether the source object's current metageneration matches the given value. @optional @param if_source_metageneration_not_match [String?] Makes the operation conditional on whether the source object's current metageneration does not match the given value. @optional @param projection [String?] Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @optional @param source_generation [String?] If present, selects a specific revision of the source object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param object [GoogleCloudStorage::Object?] @return [GoogleCloudStorage::Object]
Copies a source object to a destination object. Optionally overrides metadata. @required @param source_bucket [String?] Name of the bucket in which to find the source object. @required @param source_object [String?] Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @required @param destination_bucket [String?] 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. @required @param destination_object [String?] Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param destination_kms_key_name [String?] 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. @optional @param destination_predefined_acl [String?] Apply a predefined set of access controls to the destination object. @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the destination object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the destination object's current metageneration does not match the given value. @optional @param if_source_generation_match [String?] Makes the operation conditional on whether the source object's current generation matches the given value. @optional @param if_source_generation_not_match [String?] Makes the operation conditional on whether the source object's current generation does not match the given value. @optional @param if_source_metageneration_match [String?] Makes the operation conditional on whether the source object's current metageneration matches the given value. @optional @param if_source_metageneration_not_match [String?] Makes the operation conditional on whether the source object's current metageneration does not match the given value. @optional @param projection [String?] Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @optional @param source_generation [String?] If present, selects a specific revision of the source object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param object [GoogleCloudStorage::Object?] @return nil
Copies a source object to a destination object. Optionally overrides metadata. @required @param source_bucket [String?] Name of the bucket in which to find the source object. @required @param source_object [String?] Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @required @param destination_bucket [String?] 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. @required @param destination_object [String?] Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param destination_kms_key_name [String?] 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. @optional @param destination_predefined_acl [String?] Apply a predefined set of access controls to the destination object. @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the destination object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the destination object's current metageneration does not match the given value. @optional @param if_source_generation_match [String?] Makes the operation conditional on whether the source object's current generation matches the given value. @optional @param if_source_generation_not_match [String?] Makes the operation conditional on whether the source object's current generation does not match the given value. @optional @param if_source_metageneration_match [String?] Makes the operation conditional on whether the source object's current metageneration matches the given value. @optional @param if_source_metageneration_not_match [String?] Makes the operation conditional on whether the source object's current metageneration does not match the given value. @optional @param projection [String?] Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @optional @param source_generation [String?] If present, selects a specific revision of the source object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param object [GoogleCloudStorage::Object?] @return [Tuple(GoogleCloudStorage::Object, Integer, Hash)] GoogleCloudStorage::Object, response status code and response headers
Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [Nil]
Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return nil
Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers
Retrieves an object or its metadata. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param projection [String?] Set of properties to return. Defaults to noAcl. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [GoogleCloudStorage::Object]
Retrieves an object or its metadata. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param projection [String?] Set of properties to return. Defaults to noAcl. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return nil
Returns an IAM policy for the specified object. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [GoogleCloudStorage::Policy]
Returns an IAM policy for the specified object. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return nil
Returns an IAM policy for the specified object. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [Tuple(GoogleCloudStorage::Policy, Integer, Hash)] GoogleCloudStorage::Policy, response status code and response headers
Retrieves an object or its metadata. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param projection [String?] Set of properties to return. Defaults to noAcl. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [Tuple(GoogleCloudStorage::Object, Integer, Hash)] GoogleCloudStorage::Object, response status code and response headers
Stores a new object and metadata. @required @param bucket [String?] Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param content_encoding [String?] 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. @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param kms_key_name [String?] 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. @optional @param name [String?] 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. @optional @param predefined_acl [String?] Apply a predefined set of access controls to this object. @optional @param projection [String?] Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param body [::File?] @return [GoogleCloudStorage::Object]
Stores a new object and metadata. @required @param bucket [String?] Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param content_encoding [String?] 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. @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param kms_key_name [String?] 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. @optional @param name [String?] 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. @optional @param predefined_acl [String?] Apply a predefined set of access controls to this object. @optional @param projection [String?] Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param body [::File?] @return nil
Stores a new object and metadata. @required @param bucket [String?] Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param content_encoding [String?] 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. @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param kms_key_name [String?] 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. @optional @param name [String?] 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. @optional @param predefined_acl [String?] Apply a predefined set of access controls to this object. @optional @param projection [String?] Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param body [::File?] @return [Tuple(GoogleCloudStorage::Object, Integer, Hash)] GoogleCloudStorage::Object, response status code and response headers
Retrieves a list of objects matching the criteria. @required @param bucket [String?] Name of the bucket in which to look for objects. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param delimiter [String?] 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. @optional @param end_offset [String?] 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). @optional @param include_trailing_delimiter [Bool?] If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. @optional @param max_results [Int32?] 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. @optional @param page_token [String?] A previously-returned page token representing part of the larger set of results to view. @optional @param prefix [String?] Filter results to objects whose names begin with this prefix. @optional @param projection [String?] Set of properties to return. Defaults to noAcl. @optional @param start_offset [String?] 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). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param versions [Bool?] If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. @return [GoogleCloudStorage::Objects]
Retrieves a list of objects matching the criteria. @required @param bucket [String?] Name of the bucket in which to look for objects. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param delimiter [String?] 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. @optional @param end_offset [String?] 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). @optional @param include_trailing_delimiter [Bool?] If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. @optional @param max_results [Int32?] 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. @optional @param page_token [String?] A previously-returned page token representing part of the larger set of results to view. @optional @param prefix [String?] Filter results to objects whose names begin with this prefix. @optional @param projection [String?] Set of properties to return. Defaults to noAcl. @optional @param start_offset [String?] 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). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param versions [Bool?] If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. @return nil
Retrieves a list of objects matching the criteria. @required @param bucket [String?] Name of the bucket in which to look for objects. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param delimiter [String?] 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. @optional @param end_offset [String?] 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). @optional @param include_trailing_delimiter [Bool?] If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. @optional @param max_results [Int32?] 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. @optional @param page_token [String?] A previously-returned page token representing part of the larger set of results to view. @optional @param prefix [String?] Filter results to objects whose names begin with this prefix. @optional @param projection [String?] Set of properties to return. Defaults to noAcl. @optional @param start_offset [String?] 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). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param versions [Bool?] If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. @return [Tuple(GoogleCloudStorage::Objects, Integer, Hash)] GoogleCloudStorage::Objects, response status code and response headers
Patches an object's metadata. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param predefined_acl [String?] Apply a predefined set of access controls to this object. @optional @param projection [String?] Set of properties to return. Defaults to full. @optional @param user_project [String?] The project to be billed for this request, for Requester Pays buckets. @optional @param object2 [GoogleCloudStorage::Object?] @return [GoogleCloudStorage::Object]
Patches an object's metadata. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param predefined_acl [String?] Apply a predefined set of access controls to this object. @optional @param projection [String?] Set of properties to return. Defaults to full. @optional @param user_project [String?] The project to be billed for this request, for Requester Pays buckets. @optional @param object2 [GoogleCloudStorage::Object?] @return nil
Patches an object's metadata. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param predefined_acl [String?] Apply a predefined set of access controls to this object. @optional @param projection [String?] Set of properties to return. Defaults to full. @optional @param user_project [String?] The project to be billed for this request, for Requester Pays buckets. @optional @param object2 [GoogleCloudStorage::Object?] @return [Tuple(GoogleCloudStorage::Object, Integer, Hash)] GoogleCloudStorage::Object, response status code and response headers
Rewrites a source object to a destination object. Optionally overrides metadata. @required @param source_bucket [String?] Name of the bucket in which to find the source object. @required @param source_object [String?] Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @required @param destination_bucket [String?] Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. @required @param destination_object [String?] 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. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param destination_kms_key_name [String?] 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. @optional @param destination_predefined_acl [String?] Apply a predefined set of access controls to the destination object. @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the destination object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the destination object's current metageneration does not match the given value. @optional @param if_source_generation_match [String?] Makes the operation conditional on whether the source object's current generation matches the given value. @optional @param if_source_generation_not_match [String?] Makes the operation conditional on whether the source object's current generation does not match the given value. @optional @param if_source_metageneration_match [String?] Makes the operation conditional on whether the source object's current metageneration matches the given value. @optional @param if_source_metageneration_not_match [String?] Makes the operation conditional on whether the source object's current metageneration does not match the given value. @optional @param max_bytes_rewritten_per_call [String?] 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. @optional @param projection [String?] Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @optional @param rewrite_token [String?] 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. @optional @param source_generation [String?] If present, selects a specific revision of the source object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param object [GoogleCloudStorage::Object?] @return [GoogleCloudStorage::RewriteResponse]
Rewrites a source object to a destination object. Optionally overrides metadata. @required @param source_bucket [String?] Name of the bucket in which to find the source object. @required @param source_object [String?] Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @required @param destination_bucket [String?] Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. @required @param destination_object [String?] 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. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param destination_kms_key_name [String?] 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. @optional @param destination_predefined_acl [String?] Apply a predefined set of access controls to the destination object. @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the destination object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the destination object's current metageneration does not match the given value. @optional @param if_source_generation_match [String?] Makes the operation conditional on whether the source object's current generation matches the given value. @optional @param if_source_generation_not_match [String?] Makes the operation conditional on whether the source object's current generation does not match the given value. @optional @param if_source_metageneration_match [String?] Makes the operation conditional on whether the source object's current metageneration matches the given value. @optional @param if_source_metageneration_not_match [String?] Makes the operation conditional on whether the source object's current metageneration does not match the given value. @optional @param max_bytes_rewritten_per_call [String?] 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. @optional @param projection [String?] Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @optional @param rewrite_token [String?] 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. @optional @param source_generation [String?] If present, selects a specific revision of the source object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param object [GoogleCloudStorage::Object?] @return nil
Rewrites a source object to a destination object. Optionally overrides metadata. @required @param source_bucket [String?] Name of the bucket in which to find the source object. @required @param source_object [String?] Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @required @param destination_bucket [String?] Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. @required @param destination_object [String?] 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. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param destination_kms_key_name [String?] 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. @optional @param destination_predefined_acl [String?] Apply a predefined set of access controls to the destination object. @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the destination object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the destination object's current metageneration does not match the given value. @optional @param if_source_generation_match [String?] Makes the operation conditional on whether the source object's current generation matches the given value. @optional @param if_source_generation_not_match [String?] Makes the operation conditional on whether the source object's current generation does not match the given value. @optional @param if_source_metageneration_match [String?] Makes the operation conditional on whether the source object's current metageneration matches the given value. @optional @param if_source_metageneration_not_match [String?] Makes the operation conditional on whether the source object's current metageneration does not match the given value. @optional @param max_bytes_rewritten_per_call [String?] 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. @optional @param projection [String?] Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @optional @param rewrite_token [String?] 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. @optional @param source_generation [String?] If present, selects a specific revision of the source object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param object [GoogleCloudStorage::Object?] @return [Tuple(GoogleCloudStorage::RewriteResponse, Integer, Hash)] GoogleCloudStorage::RewriteResponse, response status code and response headers
Updates an IAM policy for the specified object. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param policy [GoogleCloudStorage::Policy?] @return [GoogleCloudStorage::Policy]
Updates an IAM policy for the specified object. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param policy [GoogleCloudStorage::Policy?] @return nil
Updates an IAM policy for the specified object. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param policy [GoogleCloudStorage::Policy?] @return [Tuple(GoogleCloudStorage::Policy, Integer, Hash)] GoogleCloudStorage::Policy, response status code and response headers
Tests a set of permissions on the given object to see which, if any, are held by the caller. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @required @param permissions [Array(String)?] Permissions to test. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [GoogleCloudStorage::TestIamPermissionsResponse]
Tests a set of permissions on the given object to see which, if any, are held by the caller. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @required @param permissions [Array(String)?] Permissions to test. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return nil
Tests a set of permissions on the given object to see which, if any, are held by the caller. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @required @param permissions [Array(String)?] Permissions to test. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @return [Tuple(GoogleCloudStorage::TestIamPermissionsResponse, Integer, Hash)] GoogleCloudStorage::TestIamPermissionsResponse, response status code and response headers
Updates an object's metadata. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param predefined_acl [String?] Apply a predefined set of access controls to this object. @optional @param projection [String?] Set of properties to return. Defaults to full. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param object2 [GoogleCloudStorage::Object?] @return [GoogleCloudStorage::Object]
Updates an object's metadata. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param predefined_acl [String?] Apply a predefined set of access controls to this object. @optional @param projection [String?] Set of properties to return. Defaults to full. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param object2 [GoogleCloudStorage::Object?] @return nil
Updates an object's metadata. @required @param bucket [String?] Name of the bucket in which the object resides. @required @param object [String?] Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param generation [String?] If present, selects a specific revision of this object (as opposed to the latest version, the default). @optional @param if_generation_match [String?] 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. @optional @param if_generation_not_match [String?] 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. @optional @param if_metageneration_match [String?] Makes the operation conditional on whether the object's current metageneration matches the given value. @optional @param if_metageneration_not_match [String?] Makes the operation conditional on whether the object's current metageneration does not match the given value. @optional @param predefined_acl [String?] Apply a predefined set of access controls to this object. @optional @param projection [String?] Set of properties to return. Defaults to full. @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param object2 [GoogleCloudStorage::Object?] @return [Tuple(GoogleCloudStorage::Object, Integer, Hash)] GoogleCloudStorage::Object, response status code and response headers
Watch for changes on all objects in a bucket. @required @param bucket [String?] Name of the bucket in which to look for objects. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param delimiter [String?] 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. @optional @param end_offset [String?] 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). @optional @param include_trailing_delimiter [Bool?] If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. @optional @param max_results [Int32?] 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. @optional @param page_token [String?] A previously-returned page token representing part of the larger set of results to view. @optional @param prefix [String?] Filter results to objects whose names begin with this prefix. @optional @param projection [String?] Set of properties to return. Defaults to noAcl. @optional @param start_offset [String?] 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). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param versions [Bool?] If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. @optional @param channel [GoogleCloudStorage::Channel?] @return [GoogleCloudStorage::Channel]
Watch for changes on all objects in a bucket. @required @param bucket [String?] Name of the bucket in which to look for objects. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param delimiter [String?] 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. @optional @param end_offset [String?] 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). @optional @param include_trailing_delimiter [Bool?] If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. @optional @param max_results [Int32?] 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. @optional @param page_token [String?] A previously-returned page token representing part of the larger set of results to view. @optional @param prefix [String?] Filter results to objects whose names begin with this prefix. @optional @param projection [String?] Set of properties to return. Defaults to noAcl. @optional @param start_offset [String?] 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). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param versions [Bool?] If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. @optional @param channel [GoogleCloudStorage::Channel?] @return nil
Watch for changes on all objects in a bucket. @required @param bucket [String?] Name of the bucket in which to look for objects. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] 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. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param upload_type [String?] Upload protocol for media (e.g. "media", "multipart", "resumable"). @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param delimiter [String?] 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. @optional @param end_offset [String?] 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). @optional @param include_trailing_delimiter [Bool?] If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. @optional @param max_results [Int32?] 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. @optional @param page_token [String?] A previously-returned page token representing part of the larger set of results to view. @optional @param prefix [String?] Filter results to objects whose names begin with this prefix. @optional @param projection [String?] Set of properties to return. Defaults to noAcl. @optional @param start_offset [String?] 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). @optional @param user_project [String?] The project to be billed for this request. Required for Requester Pays buckets. @optional @param versions [Bool?] If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. @optional @param channel [GoogleCloudStorage::Channel?] @return [Tuple(GoogleCloudStorage::Channel, Integer, Hash)] GoogleCloudStorage::Channel, response status code and response headers