UPdZddlmZddlmZddlmZddlZddlZddlmZddl m Z dZ Gd d e Z Gd d e ZGd deZGddeZGddeZGddeZGddeZGdde ZGddeZGdde ZGdde ZdZy) z?Classes for cloud/file references yielded by storage iterators.)absolute_import)division)unicode_literalsN)errors) resource_util_NOT_SUPPORTED_DO_NOT_DISPLAYcBeZdZdZdZdZdZdZdZdZ e dZ y ) ResourceaBase class for a reference to one fully expanded iterator result. This allows polymorphic iteration over wildcard-iterated URLs. The reference contains a fully expanded URL string containing no wildcards and referring to exactly one entity (if a wildcard is contained, it is assumed this is part of the raw string and should never be treated as a wildcard). Each reference represents a Bucket, Object, or Prefix. For filesystem URLs, Objects represent files and Prefixes represent directories. The metadata_object member contains the underlying object as it was retrieved. It is populated by the calling iterator, which may only request certain fields to reduce the number of server requests. For filesystem and prefix URLs, metadata_object is not populated. Attributes: TYPE_STRING (str): String representing the resource's content type. storage_url (StorageUrl): A StorageUrl object representing the resource. resourcec||_y)zInitialize the Resource object. Args: storage_url_object (StorageUrl): A StorageUrl object representing the resource. N) storage_url)selfstorage_url_objects Flib/googlecloudsdk/command_lib/storage/resources/resource_reference.py__init__zResource.__init__6s *Dctjtjd|jj fd|j fgS)z&Formats resource for printing as JSON.urltype)rconfigured_json_dumps collections OrderedDictr url_string TYPE_STRINGrs r get_json_dumpzResource.get_json_dump?sJ  . . D$$// 0 T%% &!    rc.|jjSN)r rrs r__repr__zResource.__repr__Gs    & &&rcdt||jxr|j|jk(Sr) isinstance __class__r )rothers r__eq__zResource.__eq__Ms.5$..) . E---rctd)Nz is_container must be overridden.NotImplementedErrorrs r is_containerzResource.is_containerSs @ AArcy)z+Returns whether this resource is a symlink.Frs r is_symlinkzResource.is_symlinkVs rN) __name__ __module__ __qualname____doc__rrrrr$r(propertyr+r*rrr r s<(+* '  B  rr c*eZdZdZdZedZdZy) CloudResourcea5For Resource classes with CloudUrl's. Attributes: TYPE_STRING (str): String representing the resource's content type. scheme (storage_url.ProviderPrefix): Prefix indicating what cloud provider hosts the bucket. storage_url (StorageUrl): A StorageUrl object representing the resource. cloud_resourcec.|jjSr)r schemers rr5zCloudResource.schemegs    " ""rciS)aUReturns provider specific formatting for the acl fields. Provider specific resource classses can override this method to return provider specific formatting for acl fields. If not overriden, acl values are displayed as-is if present. Returns: Dictionary with acl fields as key and corresponding formatted values. r*rs rget_formatted_aclzCloudResource.get_formatted_aclks  IrN)r,r-r.r/rr0r5r7r*rrr2r2\s%!+ # # rr2ceZdZdZdZ d fd ZedZedZedZ fdZ dZ xZ S) BucketResourceap Class representing a bucket. Warning: After being run through through output formatter utils (e.g. in `shim_format_util.py`), these fields may all be strings. Attributes: TYPE_STRING (str): String representing the resource's content type. storage_url (StorageUrl): A StorageUrl object representing the bucket. name (str): Name of bucket. scheme (storage_url.ProviderPrefix): Prefix indicating what cloud provider hosts the bucket. acl (dict|CloudApiError|None): ACLs dict or predefined-ACL string for the bucket. If the API call to fetch the data failed, this can be an error string. cors_config (dict|CloudApiError|None): CORS configuration for the bucket. If the API call to fetch the data failed, this can be an error string. creation_time (datetime|None): Bucket's creation time in UTC. default_event_based_hold (bool|None): Prevents objects in bucket from being deleted. Currently GCS-only but needed for generic copy logic. default_storage_class (str|None): Default storage class for objects in bucket. etag (str|None): HTTP version identifier. labels (dict|None): Labels for the bucket. lifecycle_config (dict|CloudApiError|None): Lifecycle configuration for bucket. If the API call to fetch the data failed, this can be an error string. location (str|None): Represents region bucket was created in. If the API call to fetch the data failed, this can be an error string. logging_config (dict|CloudApiError|None): Logging configuration for bucket. If the API call to fetch the data failed, this can be an error string. metadata (object|dict|None): Cloud-provider specific data type for holding bucket metadata. metageneration (int|None): The generation of the bucket's metadata. requester_pays (bool|CloudApiError|None): "Requester pays" status of bucket. If the API call to fetch the data failed, this can be an error string. retention_period (int|None): Default time to hold items in bucket before before deleting in seconds. Generated from retention_policy. retention_policy (dict|None): Info about object retention within bucket. retention_policy_is_locked (bool|None): True if a retention policy is locked. update_time (str|None): Bucket's update time. versioning_enabled (bool|CloudApiError|None): Whether past object versions are saved. If the API call to fetch the data failed, this can be an error string. website_config (dict|CloudApiError|None): Website configuration for bucket. If the API call to fetch the data failed, this can be an error string. cloud_bucketctt| |||_||_||_||_||_||_||_ | |_ | |_ | |_ | |_ | |_||_||_||_||_||_y6Initializes resource. Args are a subset of attributes.N)superr9racl cors_config creation_timedefault_event_based_holddefault_storage_classetaglabelslifecycle_configlocationlogging_configmetadatametagenerationrequester_paysretention_policy update_timeversioning_enabledwebsite_config)rrr?r@rArBrCrDrErFrGrHrJrIrKrLrMrNrOr"s rrzBucketResource.__init__s( .$();<DH"D&D$r9r$r?r@rArBrCrDrGrErFrHrIrJrKrLrMrNrOrr#r"s rr$zBucketResource.__eq__s .$ .u 5 8 HH ! 8&*&6&6%:K:K&K 8   %"5"5 5 8  ) )U-K-K K 8  & &%*E*E E  8 II #  8 )- (G  8 KK5<< '  8  ! !U%;%; ; 8 MMU^^ + 8   5#7#7 7 8 MMU^^ + 8   5#7#7 7 8   5#7#7 7 8  ! !U%;%; ; 8    1 1 1 8  # #u'?'? ? 8   5#7#7 7!9rcyNTr*rs rr(zBucketResource.is_container r)NNNNNNNNNNNNNNNNN) r,r-r.r/rrr0rSrVrYr$r( __classcell__r"s@rr9r9xs.^+!(,%) $""" $"&"%%)N ( (    9&rr9ceZdZdZdZ d fd ZedZedZedZ edZ fdZ d Z d Z xZS) ObjectResourcea Class representing a cloud object confirmed to exist. Warning: After being run through through output formatter utils (e.g. in `shim_format_util.py`), these fields may all be strings. Attributes: TYPE_STRING (str): String representing the resource's type. storage_url (StorageUrl): A StorageUrl object representing the object. scheme (storage_url.ProviderPrefix): Prefix indicating what cloud provider hosts the object. bucket (str): Bucket that contains the object. name (str): Name of object. generation (str|None): Generation (or "version") of the underlying object. acl (dict|str|None): ACLs dict or predefined-ACL string for the objects. If the API call to fetch the data failed, this can be an error string. cache_control (str|None): Describes the object's cache settings. component_count (int|None): Number of components, if any. content_disposition (str|None): Whether the object should be displayed or downloaded. content_encoding (str|None): Encodings that have been applied to the object. content_language (str|None): Language used in the object's content. content_type (str|None): A MIME type describing the object's content. custom_time (str|None): A timestamp in RFC 3339 format specified by the user for an object. Currently, GCS-only, but not in provider-specific class because generic daisy chain logic uses the field. crc32c_hash (str|None): Base64-encoded digest of crc32c hash. creation_time (datetime|None): Time the object was created. custom_fields (dict|None): Custom key-value pairs set by users. decryption_key_hash_sha256 (str|None): Digest of a customer-supplied encryption key. encryption_algorithm (str|None): Encryption algorithm used for encrypting the object if CSEK is used. etag (str|None): HTTP version identifier. event_based_hold (bool|None): Event based hold information for the object. Currently, GCS-only, but left generic because can affect copy logic. kms_key (str|None): Resource identifier of a Google-managed encryption key. md5_hash (str|None): Base64-encoded digest of md5 hash. metadata (object|dict|None): Cloud-specific metadata type. metageneration (int|None): Generation object's metadata. noncurrent_time (datetime|None): Noncurrent time value for the object. retention_expiration (datetime|None): Retention expiration information. size (int|None): Size of object in bytes (equivalent to content_length). storage_class (str|None): Storage class of the bucket. temporary_hold (bool|None): Temporary hold information for the object. update_time (datetime|None): Time the object was updated. cloud_objectctt| |||_||_||_||_||_||_||_ | |_ | |_ | |_ | |_ | |_||_||_||_||_||_||_||_||_||_||_||_||_||_yr<)r>rbrr? cache_controlcomponent_countcontent_dispositioncontent_encodingcontent_language content_type crc32c_hashrA custom_fields custom_timedecryption_key_hash_sha256encryption_algorithmrDevent_based_holdkms_keymd5_hashrJrInoncurrent_timeretention_expirationsize storage_classtemporary_holdrM)rrr?rerfrgrhrirjrkrArlrmrnrorDrprqrrrIrJrsrtrurvrwrMr"s rrzObjectResource.__init__'s8 .$();<DH&D*D2D,D,D$D"D&D&D"D&@D# 4DDI,DDLDM(DDM*D 4DDI&D(D"Drc.|jjSrrQrs rbucketzObjectResource.bucket^rTrc.|jjSrr resource_namers rrSzObjectResource.nameb    ) ))rc.|jjSr)r generationrs rrzObjectResource.generationfs    & &&rc|jrtj|jvry|jtjjdk(S)z)Returns whether this object is a symlink.Ftrue)rlrSYMLINK_METADATA_KEYlowerrs rr+zObjectResource.is_symlinkjsK     - -T5G5G G  ===>DDF&Prctt| |xr|j|jk(xr|j|jk(xrx|j |j k(xr\|j |j k(xr@|j|jk(xr$|j|jk(xr|j|jk(xr|j|jk(xr|j|jk(xr|j|jk(xr|j|jk(xr||j|jk(xr`|j|jk(xrD|j |j k(xr(|j"|j"k(xr |j$|j$k(xr|j&|j&k(xr|j(|j(k(xr|j*|j*k(xr|j,|j,k(xr|j.|j.k(xrj|j0|j0k(xrO|j2|j2k(xr4|j4|j4k(xr|j6|j6k(Sr)r>rbr$r?rerfrgrhrirjrkrArlrmrnrorDrprqrrrIrJrsrtrurvrwrMr[s rr$zObjectResource.__eq__vs nd*51 .dhh%))6K . e111 .  5 55 .   E$=$== . !7!77  . !7!77  . U///  . E--- . e111 . e111 . E--- . ''5+K+KK . !!U%?%?? . UZZ . !7!77 .  % .+/--5>>*I . '! ." u333# .$  5 55% .& !!U%?%??' .( UZZ) .* e111+ ., u333- .. E---1/rcyNFr*rs rr(zObjectResource.is_container rctrr&rs r is_encryptedzObjectResource.is_encrypteds r)NNNNNNNNNNNNNNNNNNNNNNNNN)r,r-r.r/rrr0ryrSrr+r$r(rr_r`s@rrbrbs-\+!##' $ $ !!*.$( $"#$(!"55#n ( ( * * ' '    /6rrbc,eZdZdZdZfdZdZxZS)PrefixResourcezClass representing a cloud object. Attributes: TYPE_STRING (str): String representing the resource's content type. storage_url (StorageUrl): A StorageUrl object representing the prefix. prefix (str): A string representing the prefix. prefixc:tt| |||_y)zInitialize the PrefixResource object. Args: storage_url_object (StorageUrl): A StorageUrl object representing the prefix. prefix (str): A string representing the prefix. N)r>rrr)rrrr"s rrzPrefixResource.__init__s .$();<DKrcyr]r*rs rr(zPrefixResource.is_containerr^r)r,r-r.r/rrr(r_r`s@rrrs+ rrcjeZdZdZdZ dfd ZedZedZedZ fdZ xZ S) ManagedFolderResourcez$Class representing a managed folder.managed_foldercztt| ||j||_||_||_||_yr)r>rrr| create_timerIrJrMrrrrIrJrMr"s rrzManagedFolderResource.__init__sB /.<<#DDM(D"Drc.|jjSrrQrs rryzManagedFolderResource.bucketrTrcyrr*rs rr+z ManagedFolderResource.is_symlink rc.|jjSrr{rs rrSzManagedFolderResource.namer}rc8tt| |xr|j|jk(xrj|j|jk(xrO|j |j k(xr4|j |j k(xr|j|jk(Sr)r>rr$r rrIrJrMr[s rr$zManagedFolderResource.__eq__s #T1%8 2    1 1 1 2    1 1 1 2 MMU^^ + 2   5#7#7 7  2    1 1 1 rNNNN r,r-r.r/rrr0ryr+rSr$r_r`s@rrrsd, +  #  ( (   * *rrcjeZdZdZdZ dfd ZedZedZedZ fdZ xZ S) FolderResourcezClass representing a folder.foldercztt| ||j||_||_||_||_yr)r>rrr|rrIrJrMrs rrzFolderResource.__init__sA .$(.<<#DDM(D"Drc.|jjSrrQrs rryzFolderResource.bucketrTrcyrr*rs rr+zFolderResource.is_symlinkrrc.|jjSrr{rs rrSzFolderResource.namer}rc8tt| |xr|j|jk(xrj|j|jk(xrO|j |j k(xr4|j |j k(xr|j|jk(Sr)r>rr$r rrIrJrMr[s rr$zFolderResource.__eq__s nd*51 2    1 1 1 2    1 1 1 2 MMU^^ + 2   5#7#7 7  2    1 1 1 rrrr`s@rrrsd$+  #  ( (   * *rrcNeZdZdZdZdfd ZdZedZedZ xZ S)FileObjectResourceaWrapper for a filesystem file. Attributes: TYPE_STRING (str): String representing the resource's content type. size (int|None): Size of local file in bytes or None if pipe or stream. storage_url (StorageUrl): A StorageUrl object representing the resource. md5_hash (bytes): Base64-encoded digest of MD5 hash. is_symlink (bool|None): Whether this file is known to be a symlink. file_objectcHtt| |||_||_yr<)r>rrrr _is_symlink)rrrrr+r"s rrzFileObjectResource.__init__s# d,-?@DM!Drcyrr*rs rr(zFileObjectResource.is_containerrrc|jjrytjj |jj S)z,Returns file size or None if pipe or stream.N)r is_streamospathgetsizer|rs rruzFileObjectResource.sizes5 !!  77??4++99 ::rc|j8tjj|jj |_|jS)z'Returns whether this file is a symlink.)rrrislinkr r|rs rr+zFileObjectResource.is_symlink%s= (8(8(F(FGd   r)NN) r,r-r.r/rrr(r0rur+r_r`s@rrr sA+"  ; ;   rrcDeZdZdZdfd ZedZedZxZS)FileSymlinkPlaceholderResourcezjA file to a symlink that should be preserved as a placeholder. Attributes: Refer to super class. c0tt| ||dy)r=TN)r>rr)rrrrr"s rrz'FileSymlinkPlaceholderResource.__init__4s ($8Hdrcttj|jjj dS)zEReturns the length of the symlink target to be used as a placeholder.zutf-8)lenrreadlinkr r|encoders rruz#FileSymlinkPlaceholderResource.size:s/ r{{4++99:AA'J KKrcyr]r*rs rr+z)FileSymlinkPlaceholderResource.is_symlink?s rr) r,r-r.r/rr0rur+r_r`s@rrr-s7   L L  rrceZdZdZdZdZy)FileDirectoryResourcez$Wrapper for a File system directory.file_directorycyr]r*rs rr(z"FileDirectoryResource.is_containerHr^rNr,r-r.r/rr(r*rrrrDs, +rrceZdZdZdZdZy)UnknownResourcez0Represents a resource that may or may not exist.unknownc,tjd)Nz6Unknown whether or not UnknownResource is a container.)rValueCannotBeDeterminedErrorrs rr(zUnknownResource.is_containerPs  - -@ BBrNrr*rrrrLs8+Brrcvt|tr|jjS|j S)z@Returns if resource is a known or unverified container resource.)r!rr is_bucketr()r s r!is_container_or_has_container_urlrUs0/*    ) ) ++     r)r/ __future__rrrrr"googlecloudsdk.command_lib.storager,googlecloudsdk.command_lib.storage.resourcesrNOT_SUPPORTED_DO_NOT_DISPLAYobjectr r2r9rbrrrrrrrrr*rrrsF&' 5F ?:v:zH8{]{|_]_D]2)N)X)^)X!!H%7.HBhB!r