s? S r SSKJr SSKJr SSKJr SSKJr SSKrSSKJr SSK J
r
SS K J r SS
K J r SS K
Jr SS KJr SS
KJr SSKJr SSKJr SSKJr SSKJr SSKJr SSK J r SSK J r SSK J!r! SSK"J#r# SSK$J%r% SSK&J'r' SSK(J)r) SSK(J*r* SSK+J,r, SS K+J-r- SS K.J/r/ SS K.J0r0 SS K.J1r1 \!Rd r3S r4S!\4- S"- r5/ S#Qr6/ S$Qr7S% r8S)S& jr9 " S' S(\5 r:g)*zDImplementation of setmeta command for setting cloud object metadata. )absolute_import)print_function)division)unicode_literalsN)encoding)AccessDeniedException)PreconditionException)
Preconditions)Command)CommandArgument) ApiSelector)CommandException)NameExpansionIterator) SeekAheadNameExpansionIterator)StorageUrlFromString)storage_v1_messages)MetadataMessage) constants)parallelism_framework_util)GetCloudApiInstance)IsCustomMetadataHeader)Retry)GcloudStorageFlag)GcloudStorageMap)InsistAsciiHeader)InsistAsciiHeaderValue)CopyObjectMetadata)ObjectMetadataFromHeaders)PreconditionsFromHeadersz6
gsutil setmeta -h [header:value|header] ... url...
z
SYNOPSIS
u
DESCRIPTION
The gsutil setmeta command allows you to set or remove the metadata on one
or more objects. It takes one or more header arguments followed by one or
more URLs, where each header argument is in one of two forms:
- If you specify ``header:value``, it sets the provided value for the
given header on all applicable objects.
- If you specify ``header`` (with no value), it removes the given header
from all applicable objects.
For example, the following command sets the ``Content-Type`` and
``Cache-Control`` headers while also removing the ``Content-Disposition``
header on the specified objects:
gsutil setmeta -h "Content-Type:text/html" \
-h "Cache-Control:public, max-age=3600" \
-h "Content-Disposition" gs://bucket/*.html
If you have a large number of objects to update you might want to use the
gsutil -m option, to perform a parallel (multi-threaded/multi-processing)
update:
gsutil -m setmeta -h "Content-Type:text/html" \
-h "Cache-Control:public, max-age=3600" \
-h "Content-Disposition" gs://bucket/*.html
You can also use the setmeta command to set custom metadata on an object:
gsutil setmeta -h "x-goog-meta-icecreamflavor:vanilla" gs://bucket/object
Custom metadata is always prefixed in gsutil with ``x-goog-meta-``. This
distinguishes it from standard request headers. Other tools that send and
receive object metadata by using the request body do not use this prefix.
While gsutil supports custom metadata with arbitrary Unicode values, note
that when setting metadata using the XML API, which sends metadata as HTTP
headers, Unicode characters are encoded using UTF-8, then url-encoded to
ASCII. For example:
gsutil setmeta -h "x-goog-meta-foo: ã" gs://bucket/object
stores the custom metadata key-value pair of ``foo`` and ``%C3%A3``.
Subsequently, running ``ls -L`` using the JSON API to list the object's
metadata prints ``%C3%A3``, while ``ls -L`` using the XML API url-decodes
this value automatically, printing the character ``ã``.
The setmeta command reads each object's current generation and metageneration
and uses those as preconditions unless they are otherwise specified by
top-level arguments. For example, the following command sets the custom
metadata ``icecreamflavor:vanilla`` if the current live object has a
metageneration of 2:
gsutil -h "x-goog-if-metageneration-match:2" setmeta
-h "x-goog-meta-icecreamflavor:vanilla"
See `Object metadata `_ for
more information about object metadata.
OPTIONS
-h Specifies a header:value to be added, or header to be removed,
from each named object.
)z
cache-controlzcontent-dispositionzcontent-encodingzcontent-languagez content-typez custom-time)storageobjectsupdatec H U R R U5 SU l g)zDException handler that maintains state about post-completion status.FN)loggererroreverything_set_okay)clses )platform/gsutil/gslib/commands/setmeta.py _SetMetadataExceptionHandlerr* s **1 !# c " U R XS9 g )N thread_state)SetMetadataFunc)r' name_expansion_resultr. s r) _SetMetadataFuncWrapperr1 s +Gr+ c D ^ \ rS rSrSr\R " SS/\S\R SSSS\
R \
R /\
R \
R " 5 /S9 r\R " SS/S S
\0 S 9r\" \0 S 9rU 4S
jrS r\" \SSS9SS j5 rS rS r Sr U =r $ )SetMetaCommand z)Implementation of gsutil setmeta command.setmeta setheader zh:rRF) command_name_aliasesusage_synopsismin_argsmax_argssupported_sub_args file_url_okprovider_url_okurls_start_arggs_api_supportgs_default_apiargparse_arguments command_helpz(Set metadata on already uploaded objects) help_namehelp_name_aliases help_typehelp_one_line_summary help_textsubcommand_help_textgcloud_commandflag_mapc T > / nU R H u p#US; d M
S/n O U R U R 5 5 u pE/ U l U R U Vs0 s H ofS _M snSS9nU R USS9n[ U- U- U- n [ U 0 S9n
[ T U ] U
5 $ s snf )N)z-rz-Rz --recursiveT)unsetFrJ )sub_opts_ParseMetadataHeaders _GetHeaderStringsFromSubOpts_translate_headers _GCLOUD_OBJECTS_UPDATE_COMMANDr superget_gcloud_storage_args) selfrecursive_flago_ clear_setset_dict clear_key clear_flags set_flagscommandgcloud_storage_map __class__s r) rU &SetMetaCommand.get_gcloud_storage_args s N
l '
44 ))+-I DM))*34)YD )4D * BK'''>I->LG *
7 *+= >> 5s B%c X U R U R 5 5 u pX l U H nSU R U' M U R ( d [ S5 e[ U R
5 S:X an U R ( d] [ U R
S 5 nUR 5 ( a UR 5 ( d [ SU R
S - 5 eSU l
[ U R 5 U l
[ U R U R U R" U R$ U R
U R U R& U R( / SQS9 n[+ U R U R U R- 5 U R
U R U R& U R. S 9n U R1 [2 U[4 SUS
9 U R ( d [ S
5 eg! [6 a& nUR8 S :X a U R; 5 e S nAff = f)z,Command entry point for the setmeta command. z|gsutil setmeta requires one or more headers to be provided with the -h flag. See "gsutil help setmeta" for more information.r7 r z URL (%s) must name an objectT)
generationmetadatametageneration) all_versionscontinue_on_errorbucket_listing_fields)rh
project_id)
fail_on_errorseek_ahead_iteratori Nz+Metadata for some objects could not be set.) rP rQ metadata_changer lenargsrecursion_requestedr
IsCloudUrlIsObjectr& r headers
preconditionsr command_namedebugr$
gsutil_apirh parallel_operationsr GetSeekAheadGsutilApirk Applyr1 r* r status_WarnServiceAccounts)rV metadata_minus
metadata_plusheaderurlname_expansion_iteratorrm r( s r)
RunCommandSetMetaCommand.RunCommand s $($>$> ))+%-!N ) %'d6" ! F
G G 499~4#;#; 1 .cnn 3<<>> = ! LMM $D 1$,,?D 3
&& 22 J L 9
""$ &&??$ jj((- #%8 : # # J KK !
S !!# s G9 9
H)!H$$H) )tries timeout_secsc
^ [ XS9nUR nU R R SU5 [ R
" [ R UR 5 n[ U R R U R R S9nUR c UR Ul UR c UR Ul [ U R 5 nUR# UR$ S9nU[& R( :X a O.U[& R* :X a [- XuSS9 UnSUl
SUl UR/ UR0 UR2 UUR UUR$ S/S 9 [5 UR6 [9 [: R: " 5 S
95 g) zSets metadata on an object.
Args:
name_expansion_result: NameExpansionResult describing target object.
thread_state: gsutil Cloud API instance to use for the operation.
r- zSetting metadata on %s...) gen_matchmeta_gen_matchN)providerT)overrideid)re ru r fields) message_time) r expanded_storage_urlr$ infor
JsonToMessageapitools_messagesObjectexpanded_resultr
ru r r re rg r rn GetApiSelectorschemer
XMLJSONr PatchObjectMetadata bucket_name object_name_PutToQueueWithTimeout status_queuer time) rV r0 r. rx exp_src_urlcloud_obj_metadataru patch_obj_metadataapis r) r/ SetMetaCommand.SetMetadataFunc s %TEJ'<!// "7"G"GI "$$..))88:M & 2 = =m ##+%7%F%Fm" 343G3GH
#
#[-?-?
#
@C koo
+$O-&*#*.'"";#:#:#.#:#:#5.9.D.D1>,7,>,>+/&
# 2 :22* DFr+ c U R ( d / $ / nU R H5 u p#US:X d M
SU; d SU; a [ S5 eUR U5 M7 U$ )a Gets header values from after the "setmeta" part of the command.
Example: $ gsutil -h not:parsed setmeta is:parsed gs://bucket/object
-> ["is:parsed"]
Returns:
List[str]: Headers without the "-h" but not yet split on colons.
Raises:
CommandException Found canned ACL.
z-hz
x-goog-aclz x-amz-aclzWgsutil setmeta no longer allows canned ACLs. Use gsutil acl set ... to set canned ACLs.)rO r append)rV rt rX as r) rQ +SetMetaCommand._GetHeaderStringsFromSubOpts@ sb ==
iG
d 1 q 0 ,- - q
Nr+ c P [ 5 n[ 5 n0 n0 nSnSnSnSn U H n
U
R S5 n U u pn[ U 5 U R 5 n[ U5 nU( d3 U[
; a) [
SU < S[ [ [
5 5 < 35 eU( a3 U( a XU ' US-
nM [ X5 [ U5 nXU' US-
nM U( a UR U 5 U S-
n M UR U5 US-
nM U[ U5 :w dZ U[ U5 :w dK U[ U5 :w d< U [ U5 :w d- UR [ UR 5 5 5 ( a [
S5 eUR U5 UR U5 X$4$ )zValidates and parses metadata changes from the headers argument.
Args:
headers: Header dict to validate and parse.
Returns:
(metadata_plus, metadata_minus): Tuple of header sets to add and remove.
r :z Invalid or disallowed header (zF).
Only these fields (plus x-goog-meta-* fields) can be set or unset:
r7 z%Each header must appear at most once.)set partitionr lowerr SETTABLE_FIELDSr sortedlistr straddro intersectionkeysr" )rV rt r~ cust_metadata_minusr cust_metadata_plusnum_metadata_plus_elems num_cust_metadata_plus_elemsnum_metadata_minus_elems num_cust_metadata_minus_elemsmd_argpartsr rY valuelowercase_headeris_custom_metas r) rP $SetMetaCommand._ParseMetadataHeadersX s UN %M #$ $%! s#e v% ..>?n
0 G VD 12
45 5
',V
$
&!
+
&
!
/e*%,1(
)
!Q
&
!
!
!&
)
'1
,
'
-
.
"a
'
"U X 3}#55$,>(?? C$77%-@)AA##C
(:(:(<$=>> D EE+,-. **r+ )r& rn ru rO N) __name__
__module__ __qualname____firstlineno____doc__r CreateCommandSpec _SYNOPSISr NO_MAXr
r r r MakeZeroOrMoreCloudURLsArgument command_specHelpSpec_DETAILED_HELP_TEXT help_specr rS r` rU r r r r/ rQ rP __static_attributes__
__classcell__)ra s @r) r3 r3 s 1 ** '=
//
!%%
9
9
; ,( $
F#
) (3
?.=
~ aa8/F 9/Fb0I+ I+r+ r3 r );r
__future__r r r r r apitools.base.pyr gslib.cloud_apir r r
gslib.commandr gslib.command_argumentr gslib.cs_api_mapr
gslib.exceptionr gslib.name_expansionr r gslib.storage_urlr "gslib.third_party.storage_apitoolsr r gslib.thread_messager gslib.utilsr r gslib.utils.cloud_api_helperr gslib.utils.metadata_utilr gslib.utils.retry_utilr gslib.utils.shim_utilr r gslib.utils.text_utilr r gslib.utils.translation_helperr r r PutToQueueWithTimeoutr r r r rS r* r1 r3 r+ r) r s K & % ' % 1 1 ) ! 2 ( , 6 ? 2 W 0 ! 2 < < ( 3 2 3 8 = D C3II
AC P
"B " HO+W O+r+