Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.storage/v1.getBucketObject
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Retrieves an object or its metadata.
Using getBucketObject
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBucketObject(args: GetBucketObjectArgs, opts?: InvokeOptions): Promise<GetBucketObjectResult>
function getBucketObjectOutput(args: GetBucketObjectOutputArgs, opts?: InvokeOptions): Output<GetBucketObjectResult>
def get_bucket_object(bucket: Optional[str] = None,
generation: Optional[str] = None,
if_generation_match: Optional[str] = None,
if_generation_not_match: Optional[str] = None,
if_metageneration_match: Optional[str] = None,
if_metageneration_not_match: Optional[str] = None,
object: Optional[str] = None,
projection: Optional[str] = None,
soft_deleted: Optional[bool] = None,
user_project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBucketObjectResult
def get_bucket_object_output(bucket: Optional[pulumi.Input[str]] = None,
generation: Optional[pulumi.Input[str]] = None,
if_generation_match: Optional[pulumi.Input[str]] = None,
if_generation_not_match: Optional[pulumi.Input[str]] = None,
if_metageneration_match: Optional[pulumi.Input[str]] = None,
if_metageneration_not_match: Optional[pulumi.Input[str]] = None,
object: Optional[pulumi.Input[str]] = None,
projection: Optional[pulumi.Input[str]] = None,
soft_deleted: Optional[pulumi.Input[bool]] = None,
user_project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBucketObjectResult]
func LookupBucketObject(ctx *Context, args *LookupBucketObjectArgs, opts ...InvokeOption) (*LookupBucketObjectResult, error)
func LookupBucketObjectOutput(ctx *Context, args *LookupBucketObjectOutputArgs, opts ...InvokeOption) LookupBucketObjectResultOutput
> Note: This function is named LookupBucketObject
in the Go SDK.
public static class GetBucketObject
{
public static Task<GetBucketObjectResult> InvokeAsync(GetBucketObjectArgs args, InvokeOptions? opts = null)
public static Output<GetBucketObjectResult> Invoke(GetBucketObjectInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBucketObjectResult> getBucketObject(GetBucketObjectArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:storage/v1:getBucketObject
arguments:
# arguments dictionary
The following arguments are supported:
- Bucket string
- Object string
- Generation string
- If
Generation stringMatch - If
Generation stringNot Match - If
Metageneration stringMatch - If
Metageneration stringNot Match - Projection string
- Soft
Deleted bool - User
Project string
- Bucket string
- Object string
- Generation string
- If
Generation stringMatch - If
Generation stringNot Match - If
Metageneration stringMatch - If
Metageneration stringNot Match - Projection string
- Soft
Deleted bool - User
Project string
- bucket String
- object String
- generation String
- if
Generation StringMatch - if
Generation StringNot Match - if
Metageneration StringMatch - if
Metageneration StringNot Match - projection String
- soft
Deleted Boolean - user
Project String
- bucket string
- object string
- generation string
- if
Generation stringMatch - if
Generation stringNot Match - if
Metageneration stringMatch - if
Metageneration stringNot Match - projection string
- soft
Deleted boolean - user
Project string
- bucket str
- object str
- generation str
- if_
generation_ strmatch - if_
generation_ strnot_ match - if_
metageneration_ strmatch - if_
metageneration_ strnot_ match - projection str
- soft_
deleted bool - user_
project str
- bucket String
- object String
- generation String
- if
Generation StringMatch - if
Generation StringNot Match - if
Metageneration StringMatch - if
Metageneration StringNot Match - projection String
- soft
Deleted Boolean - user
Project String
getBucketObject Result
The following output properties are available:
- Acl
List<Pulumi.
Google Native. Storage. V1. Outputs. Object Access Control Response> - Access controls on the object.
- Bucket string
- The name of the bucket containing this object.
- Cache
Control string - Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
- Component
Count int - Number of underlying components that make up this object. Components are accumulated by compose operations.
- Content
Disposition string - Content-Disposition of the object data.
- Content
Encoding string - Content-Encoding of the object data.
- Content
Language string - Content-Language of the object data.
- Content
Type string - Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
- Crc32c string
- CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
- Custom
Time string - A timestamp in RFC 3339 format specified by the user for an object.
- Customer
Encryption Pulumi.Google Native. Storage. V1. Outputs. Bucket Object Customer Encryption Response - Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
- Etag string
- HTTP 1.1 Entity tag for the object.
- Event
Based boolHold - Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
- Generation string
- The content generation of this object. Used for object versioning.
- Hard
Delete stringTime - This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
- Kind string
- The kind of item this is. For objects, this is always storage#object.
- Kms
Key stringName - Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
- Md5Hash string
- MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
- Media
Link string - Media download link.
- Metadata Dictionary<string, string>
- User-provided metadata, in key/value pairs.
- Metageneration string
- The version of the metadata for this object at this generation. 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.
- Name string
- The name of the object. Required if not specified by URL parameter.
- Owner
Pulumi.
Google Native. Storage. V1. Outputs. Bucket Object Owner Response - The owner of the object. This will always be the uploader of the object.
- Retention
Pulumi.
Google Native. Storage. V1. Outputs. Bucket Object Retention Response - A collection of object level retention parameters.
- Retention
Expiration stringTime - A server-determined value that specifies the earliest time that the object's retention period expires. This value is in 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).
- Self
Link string - The link to this object.
- Size string
- Content-Length of the data in bytes.
- Soft
Delete stringTime - The time at which the object became soft-deleted in RFC 3339 format.
- Storage
Class string - Storage class of the object.
- 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.
- Time
Created string - The creation time of the object in RFC 3339 format.
- Time
Deleted string - The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- Time
Storage stringClass Updated - The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
- Updated string
- The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
- Acl
[]Object
Access Control Response - Access controls on the object.
- Bucket string
- The name of the bucket containing this object.
- Cache
Control string - Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
- Component
Count int - Number of underlying components that make up this object. Components are accumulated by compose operations.
- Content
Disposition string - Content-Disposition of the object data.
- Content
Encoding string - Content-Encoding of the object data.
- Content
Language string - Content-Language of the object data.
- Content
Type string - Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
- Crc32c string
- CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
- Custom
Time string - A timestamp in RFC 3339 format specified by the user for an object.
- Customer
Encryption BucketObject Customer Encryption Response - Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
- Etag string
- HTTP 1.1 Entity tag for the object.
- Event
Based boolHold - Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
- Generation string
- The content generation of this object. Used for object versioning.
- Hard
Delete stringTime - This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
- Kind string
- The kind of item this is. For objects, this is always storage#object.
- Kms
Key stringName - Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
- Md5Hash string
- MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
- Media
Link string - Media download link.
- Metadata map[string]string
- User-provided metadata, in key/value pairs.
- Metageneration string
- The version of the metadata for this object at this generation. 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.
- Name string
- The name of the object. Required if not specified by URL parameter.
- Owner
Bucket
Object Owner Response - The owner of the object. This will always be the uploader of the object.
- Retention
Bucket
Object Retention Response - A collection of object level retention parameters.
- Retention
Expiration stringTime - A server-determined value that specifies the earliest time that the object's retention period expires. This value is in 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).
- Self
Link string - The link to this object.
- Size string
- Content-Length of the data in bytes.
- Soft
Delete stringTime - The time at which the object became soft-deleted in RFC 3339 format.
- Storage
Class string - Storage class of the object.
- 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.
- Time
Created string - The creation time of the object in RFC 3339 format.
- Time
Deleted string - The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- Time
Storage stringClass Updated - The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
- Updated string
- The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
- acl
List<Object
Access Control Response> - Access controls on the object.
- bucket String
- The name of the bucket containing this object.
- cache
Control String - Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
- component
Count Integer - Number of underlying components that make up this object. Components are accumulated by compose operations.
- content
Disposition String - Content-Disposition of the object data.
- content
Encoding String - Content-Encoding of the object data.
- content
Language String - Content-Language of the object data.
- content
Type String - Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
- crc32c String
- CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
- custom
Time String - A timestamp in RFC 3339 format specified by the user for an object.
- customer
Encryption BucketObject Customer Encryption Response - Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
- etag String
- HTTP 1.1 Entity tag for the object.
- event
Based BooleanHold - Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
- generation String
- The content generation of this object. Used for object versioning.
- hard
Delete StringTime - This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
- kind String
- The kind of item this is. For objects, this is always storage#object.
- kms
Key StringName - Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
- md5Hash String
- MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
- media
Link String - Media download link.
- metadata Map<String,String>
- User-provided metadata, in key/value pairs.
- metageneration String
- The version of the metadata for this object at this generation. 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.
- name String
- The name of the object. Required if not specified by URL parameter.
- owner
Bucket
Object Owner Response - The owner of the object. This will always be the uploader of the object.
- retention
Bucket
Object Retention Response - A collection of object level retention parameters.
- retention
Expiration StringTime - A server-determined value that specifies the earliest time that the object's retention period expires. This value is in 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).
- self
Link String - The link to this object.
- size String
- Content-Length of the data in bytes.
- soft
Delete StringTime - The time at which the object became soft-deleted in RFC 3339 format.
- storage
Class String - Storage class of the object.
- temporary
Hold Boolean - 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.
- time
Created String - The creation time of the object in RFC 3339 format.
- time
Deleted String - The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- time
Storage StringClass Updated - The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
- updated String
- The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
- acl
Object
Access Control Response[] - Access controls on the object.
- bucket string
- The name of the bucket containing this object.
- cache
Control string - Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
- component
Count number - Number of underlying components that make up this object. Components are accumulated by compose operations.
- content
Disposition string - Content-Disposition of the object data.
- content
Encoding string - Content-Encoding of the object data.
- content
Language string - Content-Language of the object data.
- content
Type string - Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
- crc32c string
- CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
- custom
Time string - A timestamp in RFC 3339 format specified by the user for an object.
- customer
Encryption BucketObject Customer Encryption Response - Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
- etag string
- HTTP 1.1 Entity tag for the object.
- event
Based booleanHold - Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
- generation string
- The content generation of this object. Used for object versioning.
- hard
Delete stringTime - This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
- kind string
- The kind of item this is. For objects, this is always storage#object.
- kms
Key stringName - Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
- md5Hash string
- MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
- media
Link string - Media download link.
- metadata {[key: string]: string}
- User-provided metadata, in key/value pairs.
- metageneration string
- The version of the metadata for this object at this generation. 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.
- name string
- The name of the object. Required if not specified by URL parameter.
- owner
Bucket
Object Owner Response - The owner of the object. This will always be the uploader of the object.
- retention
Bucket
Object Retention Response - A collection of object level retention parameters.
- retention
Expiration stringTime - A server-determined value that specifies the earliest time that the object's retention period expires. This value is in 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).
- self
Link string - The link to this object.
- size string
- Content-Length of the data in bytes.
- soft
Delete stringTime - The time at which the object became soft-deleted in RFC 3339 format.
- storage
Class string - Storage class of the object.
- temporary
Hold boolean - 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.
- time
Created string - The creation time of the object in RFC 3339 format.
- time
Deleted string - The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- time
Storage stringClass Updated - The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
- updated string
- The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
- acl
Sequence[Object
Access Control Response] - Access controls on the object.
- bucket str
- The name of the bucket containing this object.
- cache_
control str - Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
- component_
count int - Number of underlying components that make up this object. Components are accumulated by compose operations.
- content_
disposition str - Content-Disposition of the object data.
- content_
encoding str - Content-Encoding of the object data.
- content_
language str - Content-Language of the object data.
- content_
type str - Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
- crc32c str
- CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
- custom_
time str - A timestamp in RFC 3339 format specified by the user for an object.
- customer_
encryption BucketObject Customer Encryption Response - Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
- etag str
- HTTP 1.1 Entity tag for the object.
- event_
based_ boolhold - Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
- generation str
- The content generation of this object. Used for object versioning.
- hard_
delete_ strtime - This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
- kind str
- The kind of item this is. For objects, this is always storage#object.
- kms_
key_ strname - Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
- md5_
hash str - MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
- media_
link str - Media download link.
- metadata Mapping[str, str]
- User-provided metadata, in key/value pairs.
- metageneration str
- The version of the metadata for this object at this generation. 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.
- name str
- The name of the object. Required if not specified by URL parameter.
- owner
Bucket
Object Owner Response - The owner of the object. This will always be the uploader of the object.
- retention
Bucket
Object Retention Response - A collection of object level retention parameters.
- retention_
expiration_ strtime - A server-determined value that specifies the earliest time that the object's retention period expires. This value is in 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).
- self_
link str - The link to this object.
- size str
- Content-Length of the data in bytes.
- soft_
delete_ strtime - The time at which the object became soft-deleted in RFC 3339 format.
- storage_
class str - Storage class of the object.
- 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.
- time_
created str - The creation time of the object in RFC 3339 format.
- time_
deleted str - The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- time_
storage_ strclass_ updated - The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
- updated str
- The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
- acl List<Property Map>
- Access controls on the object.
- bucket String
- The name of the bucket containing this object.
- cache
Control String - Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
- component
Count Number - Number of underlying components that make up this object. Components are accumulated by compose operations.
- content
Disposition String - Content-Disposition of the object data.
- content
Encoding String - Content-Encoding of the object data.
- content
Language String - Content-Language of the object data.
- content
Type String - Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
- crc32c String
- CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
- custom
Time String - A timestamp in RFC 3339 format specified by the user for an object.
- customer
Encryption Property Map - Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
- etag String
- HTTP 1.1 Entity tag for the object.
- event
Based BooleanHold - Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
- generation String
- The content generation of this object. Used for object versioning.
- hard
Delete StringTime - This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.
- kind String
- The kind of item this is. For objects, this is always storage#object.
- kms
Key StringName - Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
- md5Hash String
- MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
- media
Link String - Media download link.
- metadata Map<String>
- User-provided metadata, in key/value pairs.
- metageneration String
- The version of the metadata for this object at this generation. 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.
- name String
- The name of the object. Required if not specified by URL parameter.
- owner Property Map
- The owner of the object. This will always be the uploader of the object.
- retention Property Map
- A collection of object level retention parameters.
- retention
Expiration StringTime - A server-determined value that specifies the earliest time that the object's retention period expires. This value is in 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).
- self
Link String - The link to this object.
- size String
- Content-Length of the data in bytes.
- soft
Delete StringTime - The time at which the object became soft-deleted in RFC 3339 format.
- storage
Class String - Storage class of the object.
- temporary
Hold Boolean - 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.
- time
Created String - The creation time of the object in RFC 3339 format.
- time
Deleted String - The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
- time
Storage StringClass Updated - The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
- updated String
- The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
Supporting Types
BucketObjectCustomerEncryptionResponse
- Encryption
Algorithm string - The encryption algorithm.
- Key
Sha256 string - SHA256 hash value of the encryption key.
- Encryption
Algorithm string - The encryption algorithm.
- Key
Sha256 string - SHA256 hash value of the encryption key.
- encryption
Algorithm String - The encryption algorithm.
- key
Sha256 String - SHA256 hash value of the encryption key.
- encryption
Algorithm string - The encryption algorithm.
- key
Sha256 string - SHA256 hash value of the encryption key.
- encryption_
algorithm str - The encryption algorithm.
- key_
sha256 str - SHA256 hash value of the encryption key.
- encryption
Algorithm String - The encryption algorithm.
- key
Sha256 String - SHA256 hash value of the encryption key.
BucketObjectOwnerResponse
BucketObjectRetentionResponse
- Mode string
- The bucket's object retention mode, can only be Unlocked or Locked.
- Retain
Until stringTime - A time in RFC 3339 format until which object retention protects this object.
- Mode string
- The bucket's object retention mode, can only be Unlocked or Locked.
- Retain
Until stringTime - A time in RFC 3339 format until which object retention protects this object.
- mode String
- The bucket's object retention mode, can only be Unlocked or Locked.
- retain
Until StringTime - A time in RFC 3339 format until which object retention protects this object.
- mode string
- The bucket's object retention mode, can only be Unlocked or Locked.
- retain
Until stringTime - A time in RFC 3339 format until which object retention protects this object.
- mode str
- The bucket's object retention mode, can only be Unlocked or Locked.
- retain_
until_ strtime - A time in RFC 3339 format until which object retention protects this object.
- mode String
- The bucket's object retention mode, can only be Unlocked or Locked.
- retain
Until StringTime - A time in RFC 3339 format until which object retention protects this object.
ObjectAccessControlProjectTeamResponse
- Project
Number string - The project number.
- Team string
- The team.
- Project
Number string - The project number.
- Team string
- The team.
- project
Number String - The project number.
- team String
- The team.
- project
Number string - The project number.
- team string
- The team.
- project_
number str - The project number.
- team str
- The team.
- project
Number String - The project number.
- team String
- The team.
ObjectAccessControlResponse
- Bucket string
- The name of the bucket.
- Domain string
- The domain associated with the entity, if any.
- Email string
- The email address associated with the entity, if any.
- Entity string
- The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
- Entity
Id string - The ID for the entity, if any.
- Etag string
- HTTP 1.1 Entity tag for the access-control entry.
- Generation string
- The content generation of the object, if applied to an object.
- Kind string
- The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- Object string
- The name of the object, if applied to an object.
- Project
Team Pulumi.Google Native. Storage. V1. Inputs. Object Access Control Project Team Response - The project team associated with the entity, if any.
- Role string
- The access permission for the entity.
- Self
Link string - The link to this access-control entry.
- Bucket string
- The name of the bucket.
- Domain string
- The domain associated with the entity, if any.
- Email string
- The email address associated with the entity, if any.
- Entity string
- The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
- Entity
Id string - The ID for the entity, if any.
- Etag string
- HTTP 1.1 Entity tag for the access-control entry.
- Generation string
- The content generation of the object, if applied to an object.
- Kind string
- The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- Object string
- The name of the object, if applied to an object.
- Project
Team ObjectAccess Control Project Team Response - The project team associated with the entity, if any.
- Role string
- The access permission for the entity.
- Self
Link string - The link to this access-control entry.
- bucket String
- The name of the bucket.
- domain String
- The domain associated with the entity, if any.
- email String
- The email address associated with the entity, if any.
- entity String
- The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
- entity
Id String - The ID for the entity, if any.
- etag String
- HTTP 1.1 Entity tag for the access-control entry.
- generation String
- The content generation of the object, if applied to an object.
- kind String
- The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- object String
- The name of the object, if applied to an object.
- project
Team ObjectAccess Control Project Team Response - The project team associated with the entity, if any.
- role String
- The access permission for the entity.
- self
Link String - The link to this access-control entry.
- bucket string
- The name of the bucket.
- domain string
- The domain associated with the entity, if any.
- email string
- The email address associated with the entity, if any.
- entity string
- The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
- entity
Id string - The ID for the entity, if any.
- etag string
- HTTP 1.1 Entity tag for the access-control entry.
- generation string
- The content generation of the object, if applied to an object.
- kind string
- The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- object string
- The name of the object, if applied to an object.
- project
Team ObjectAccess Control Project Team Response - The project team associated with the entity, if any.
- role string
- The access permission for the entity.
- self
Link string - The link to this access-control entry.
- bucket str
- The name of the bucket.
- domain str
- The domain associated with the entity, if any.
- email str
- The email address associated with the entity, if any.
- entity str
- The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
- entity_
id str - The ID for the entity, if any.
- etag str
- HTTP 1.1 Entity tag for the access-control entry.
- generation str
- The content generation of the object, if applied to an object.
- kind str
- The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- object str
- The name of the object, if applied to an object.
- project_
team ObjectAccess Control Project Team Response - The project team associated with the entity, if any.
- role str
- The access permission for the entity.
- self_
link str - The link to this access-control entry.
- bucket String
- The name of the bucket.
- domain String
- The domain associated with the entity, if any.
- email String
- The email address associated with the entity, if any.
- entity String
- The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
- entity
Id String - The ID for the entity, if any.
- etag String
- HTTP 1.1 Entity tag for the access-control entry.
- generation String
- The content generation of the object, if applied to an object.
- kind String
- The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
- object String
- The name of the object, if applied to an object.
- project
Team Property Map - The project team associated with the entity, if any.
- role String
- The access permission for the entity.
- self
Link String - The link to this access-control entry.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi