Struct googapis::google::storage::v2::Object [−][src]
pub struct Object {Show 26 fields
pub name: String,
pub bucket: String,
pub generation: i64,
pub metageneration: i64,
pub storage_class: String,
pub size: i64,
pub content_encoding: String,
pub content_disposition: String,
pub cache_control: String,
pub acl: Vec<ObjectAccessControl>,
pub content_language: String,
pub delete_time: Option<Timestamp>,
pub content_type: String,
pub create_time: Option<Timestamp>,
pub component_count: i32,
pub checksums: Option<ObjectChecksums>,
pub update_time: Option<Timestamp>,
pub kms_key: String,
pub update_storage_class_time: Option<Timestamp>,
pub temporary_hold: bool,
pub retention_expire_time: Option<Timestamp>,
pub metadata: HashMap<String, String>,
pub event_based_hold: Option<bool>,
pub owner: Option<Owner>,
pub customer_encryption: Option<CustomerEncryption>,
pub custom_time: Option<Timestamp>,
}
Expand description
An object.
Fields
name: String
Immutable. The name of this object. Nearly any sequence of unicode characters is
valid. See
[Guidelines](https://cloud.google.com/storage/docs/naming-objects).
Example: test.txt
The name
field by itself does not uniquely identify a Cloud Storage
object. A Cloud Storage object is uniquely identified by the tuple of
(bucket, object, generation).
bucket: String
Immutable. The name of the bucket containing this object.
generation: i64
Immutable. The content generation of this object. Used for object versioning. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
metageneration: i64
Output only. The version of the metadata for this generation of this object. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
storage_class: String
Storage class of the object.
size: i64
Output only. Content-Length of the object data in bytes, matching [https://tools.ietf.org/html/rfc7230#section-3.3.2\][RFC 7230 §3.3.2]. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
content_encoding: String
Content-Encoding of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.2.2\][RFC 7231 §3.1.2.2]
content_disposition: String
Content-Disposition of the object data, matching [https://tools.ietf.org/html/rfc6266\][RFC 6266].
cache_control: String
Cache-Control directive for the object data, matching
[https://tools.ietf.org/html/rfc7234#section-5.2"\][RFC 7234 §5.2].
If omitted, and the object is accessible to all anonymous users, the
default will be public, max-age=3600
.
acl: Vec<ObjectAccessControl>
Access controls on the object. If iamConfig.uniformBucketLevelAccess is enabled on the parent bucket, requests to set, read, or modify acl is an error.
content_language: String
Content-Language of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.3.2\][RFC 7231 §3.1.3.2].
delete_time: Option<Timestamp>
Output only. The deletion time of the object. Will be returned if and only if this version of the object has been deleted. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
content_type: String
Content-Type of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.1.5\][RFC 7231 §3.1.1.5].
If an object is stored without a Content-Type, it is served as
application/octet-stream
.
create_time: Option<Timestamp>
Output only. The creation time of the object. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
component_count: i32
Output only. Number of underlying components that make up this object. Components are accumulated by compose operations. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
checksums: Option<ObjectChecksums>
Output only. Hashes for the data part of this object.
update_time: Option<Timestamp>
Output only. The modification time of the object metadata. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
kms_key: String
Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
update_storage_class_time: Option<Timestamp>
Output only. The time at which the object’s storage class was last changed. When the object is initially created, it will be set to time_created. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
temporary_hold: bool
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
retention_expire_time: Option<Timestamp>
A server-determined value that specifies the earliest time that the object’s retention period expires. This value is in [https://tools.ietf.org/html/rfc3339\][RFC 3339] format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
metadata: HashMap<String, String>
User-provided metadata, in key/value pairs.
event_based_hold: Option<bool>
Whether an object is under event-based hold. An event-based hold is a way to force the retention of an object until after some event occurs. Once the hold is released by explicitly setting this field to false, the object will become subject to any bucket-level retention policy, except that the retention duration will be calculated from the time the event based hold was lifted, rather than the time the object was created.
In a WriteObject request, not setting this field implies that the value should be taken from the parent bucket’s “default_event_based_hold” field. In a response, this field will always be set to true or false.
owner: Option<Owner>
Output only. The owner of the object. This will always be the uploader of the object. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
customer_encryption: Option<CustomerEncryption>
Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
custom_time: Option<Timestamp>
A user-specified timestamp set on an object.
Implementations
Returns the value of event_based_hold
, or the default value if event_based_hold
is unset.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
Auto Trait Implementations
impl RefUnwindSafe for Object
impl UnwindSafe for Object
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more