Reference documentation and code samples for the Storage Control V2 API class Google::Cloud::Storage::Control::V2::RenameFolderRequest.
Request message for RenameFolder. This operation is only applicable to a hierarchical namespace enabled bucket.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#destination_folder_id
def destination_folder_id() -> ::String
Returns
-
(::String) — Required. The destination folder ID, e.g.
foo/bar/
.
#destination_folder_id=
def destination_folder_id=(value) -> ::String
Parameter
-
value (::String) — Required. The destination folder ID, e.g.
foo/bar/
.
Returns
-
(::String) — Required. The destination folder ID, e.g.
foo/bar/
.
#if_metageneration_match
def if_metageneration_match() -> ::Integer
Returns
- (::Integer) — Makes the operation only succeed conditional on whether the source folder's current metageneration matches the given value.
#if_metageneration_match=
def if_metageneration_match=(value) -> ::Integer
Parameter
- value (::Integer) — Makes the operation only succeed conditional on whether the source folder's current metageneration matches the given value.
Returns
- (::Integer) — Makes the operation only succeed conditional on whether the source folder's current metageneration matches the given value.
#if_metageneration_not_match
def if_metageneration_not_match() -> ::Integer
Returns
- (::Integer) — Makes the operation only succeed conditional on whether the source folder's current metageneration does not match the given value.
#if_metageneration_not_match=
def if_metageneration_not_match=(value) -> ::Integer
Parameter
- value (::Integer) — Makes the operation only succeed conditional on whether the source folder's current metageneration does not match the given value.
Returns
- (::Integer) — Makes the operation only succeed conditional on whether the source folder's current metageneration does not match the given value.
#name
def name() -> ::String
Returns
-
(::String) — Required. Name of the source folder being renamed.
Format:
projects/{project}/buckets/{bucket}/folders/{folder}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Required. Name of the source folder being renamed.
Format:
projects/{project}/buckets/{bucket}/folders/{folder}
Returns
-
(::String) — Required. Name of the source folder being renamed.
Format:
projects/{project}/buckets/{bucket}/folders/{folder}
#request_id
def request_id() -> ::String
Returns
-
(::String) — Optional. A unique identifier for this request. UUID is the recommended
format, but other formats are still accepted. This request is only
idempotent if a
request_id
is provided.
#request_id=
def request_id=(value) -> ::String
Parameter
-
value (::String) — Optional. A unique identifier for this request. UUID is the recommended
format, but other formats are still accepted. This request is only
idempotent if a
request_id
is provided.
Returns
-
(::String) — Optional. A unique identifier for this request. UUID is the recommended
format, but other formats are still accepted. This request is only
idempotent if a
request_id
is provided.