1. Packages
  2. Google Cloud Native
  3. API Docs
  4. storage
  5. storage/v1
  6. getBucketObject

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

google-native.storage/v1.getBucketObject

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 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,
                          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,
                          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:

    getBucketObject Result

    The following output properties are available:

    Acl List<Pulumi.GoogleNative.Storage.V1.Outputs.ObjectAccessControlResponse>

    Access controls on the object.

    Bucket string

    The name of the bucket containing this object.

    CacheControl 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.

    ComponentCount int

    Number of underlying components that make up this object. Components are accumulated by compose operations.

    ContentDisposition string

    Content-Disposition of the object data.

    ContentEncoding string

    Content-Encoding of the object data.

    ContentLanguage string

    Content-Language of the object data.

    ContentType 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.

    CustomTime string

    A timestamp in RFC 3339 format specified by the user for an object.

    CustomerEncryption Pulumi.GoogleNative.Storage.V1.Outputs.BucketObjectCustomerEncryptionResponse

    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.

    EventBasedHold bool

    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.

    Kind string

    The kind of item this is. For objects, this is always storage#object.

    KmsKeyName string

    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.

    MediaLink 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.GoogleNative.Storage.V1.Outputs.BucketObjectOwnerResponse

    The owner of the object. This will always be the uploader of the object.

    RetentionExpirationTime string

    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).

    SelfLink string

    The link to this object.

    Size string

    Content-Length of the data in bytes.

    StorageClass string

    Storage class of the object.

    TemporaryHold 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.

    TimeCreated string

    The creation time of the object in RFC 3339 format.

    TimeDeleted string

    The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.

    TimeStorageClassUpdated string

    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 []ObjectAccessControlResponse

    Access controls on the object.

    Bucket string

    The name of the bucket containing this object.

    CacheControl 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.

    ComponentCount int

    Number of underlying components that make up this object. Components are accumulated by compose operations.

    ContentDisposition string

    Content-Disposition of the object data.

    ContentEncoding string

    Content-Encoding of the object data.

    ContentLanguage string

    Content-Language of the object data.

    ContentType 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.

    CustomTime string

    A timestamp in RFC 3339 format specified by the user for an object.

    CustomerEncryption BucketObjectCustomerEncryptionResponse

    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.

    EventBasedHold bool

    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.

    Kind string

    The kind of item this is. For objects, this is always storage#object.

    KmsKeyName string

    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.

    MediaLink 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 BucketObjectOwnerResponse

    The owner of the object. This will always be the uploader of the object.

    RetentionExpirationTime string

    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).

    SelfLink string

    The link to this object.

    Size string

    Content-Length of the data in bytes.

    StorageClass string

    Storage class of the object.

    TemporaryHold 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.

    TimeCreated string

    The creation time of the object in RFC 3339 format.

    TimeDeleted string

    The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.

    TimeStorageClassUpdated string

    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<ObjectAccessControlResponse>

    Access controls on the object.

    bucket String

    The name of the bucket containing this object.

    cacheControl 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.

    componentCount Integer

    Number of underlying components that make up this object. Components are accumulated by compose operations.

    contentDisposition String

    Content-Disposition of the object data.

    contentEncoding String

    Content-Encoding of the object data.

    contentLanguage String

    Content-Language of the object data.

    contentType 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.

    customTime String

    A timestamp in RFC 3339 format specified by the user for an object.

    customerEncryption BucketObjectCustomerEncryptionResponse

    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.

    eventBasedHold Boolean

    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.

    kind String

    The kind of item this is. For objects, this is always storage#object.

    kmsKeyName String

    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.

    mediaLink 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 BucketObjectOwnerResponse

    The owner of the object. This will always be the uploader of the object.

    retentionExpirationTime String

    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).

    selfLink String

    The link to this object.

    size String

    Content-Length of the data in bytes.

    storageClass String

    Storage class of the object.

    temporaryHold 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.

    timeCreated String

    The creation time of the object in RFC 3339 format.

    timeDeleted String

    The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.

    timeStorageClassUpdated String

    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 ObjectAccessControlResponse[]

    Access controls on the object.

    bucket string

    The name of the bucket containing this object.

    cacheControl 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.

    componentCount number

    Number of underlying components that make up this object. Components are accumulated by compose operations.

    contentDisposition string

    Content-Disposition of the object data.

    contentEncoding string

    Content-Encoding of the object data.

    contentLanguage string

    Content-Language of the object data.

    contentType 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.

    customTime string

    A timestamp in RFC 3339 format specified by the user for an object.

    customerEncryption BucketObjectCustomerEncryptionResponse

    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.

    eventBasedHold boolean

    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.

    kind string

    The kind of item this is. For objects, this is always storage#object.

    kmsKeyName string

    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.

    mediaLink 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 BucketObjectOwnerResponse

    The owner of the object. This will always be the uploader of the object.

    retentionExpirationTime string

    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).

    selfLink string

    The link to this object.

    size string

    Content-Length of the data in bytes.

    storageClass string

    Storage class of the object.

    temporaryHold 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.

    timeCreated string

    The creation time of the object in RFC 3339 format.

    timeDeleted string

    The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.

    timeStorageClassUpdated string

    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[ObjectAccessControlResponse]

    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 BucketObjectCustomerEncryptionResponse

    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_hold bool

    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.

    kind str

    The kind of item this is. For objects, this is always storage#object.

    kms_key_name str

    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 BucketObjectOwnerResponse

    The owner of the object. This will always be the uploader of the object.

    retention_expiration_time str

    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.

    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 deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.

    time_storage_class_updated str

    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.

    cacheControl 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.

    componentCount Number

    Number of underlying components that make up this object. Components are accumulated by compose operations.

    contentDisposition String

    Content-Disposition of the object data.

    contentEncoding String

    Content-Encoding of the object data.

    contentLanguage String

    Content-Language of the object data.

    contentType 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.

    customTime String

    A timestamp in RFC 3339 format specified by the user for an object.

    customerEncryption 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.

    eventBasedHold Boolean

    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.

    kind String

    The kind of item this is. For objects, this is always storage#object.

    kmsKeyName String

    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.

    mediaLink 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.

    retentionExpirationTime String

    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).

    selfLink String

    The link to this object.

    size String

    Content-Length of the data in bytes.

    storageClass String

    Storage class of the object.

    temporaryHold 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.

    timeCreated String

    The creation time of the object in RFC 3339 format.

    timeDeleted String

    The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.

    timeStorageClassUpdated String

    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

    EncryptionAlgorithm string

    The encryption algorithm.

    KeySha256 string

    SHA256 hash value of the encryption key.

    EncryptionAlgorithm string

    The encryption algorithm.

    KeySha256 string

    SHA256 hash value of the encryption key.

    encryptionAlgorithm String

    The encryption algorithm.

    keySha256 String

    SHA256 hash value of the encryption key.

    encryptionAlgorithm string

    The encryption algorithm.

    keySha256 string

    SHA256 hash value of the encryption key.

    encryption_algorithm str

    The encryption algorithm.

    key_sha256 str

    SHA256 hash value of the encryption key.

    encryptionAlgorithm String

    The encryption algorithm.

    keySha256 String

    SHA256 hash value of the encryption key.

    BucketObjectOwnerResponse

    Entity string

    The entity, in the form user-userId.

    EntityId string

    The ID for the entity.

    Entity string

    The entity, in the form user-userId.

    EntityId string

    The ID for the entity.

    entity String

    The entity, in the form user-userId.

    entityId String

    The ID for the entity.

    entity string

    The entity, in the form user-userId.

    entityId string

    The ID for the entity.

    entity str

    The entity, in the form user-userId.

    entity_id str

    The ID for the entity.

    entity String

    The entity, in the form user-userId.

    entityId String

    The ID for the entity.

    ObjectAccessControlProjectTeamResponse

    ProjectNumber string

    The project number.

    Team string

    The team.

    ProjectNumber string

    The project number.

    Team string

    The team.

    projectNumber String

    The project number.

    team String

    The team.

    projectNumber string

    The project number.

    team string

    The team.

    project_number str

    The project number.

    team str

    The team.

    projectNumber 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.
    EntityId 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.

    ProjectTeam Pulumi.GoogleNative.Storage.V1.Inputs.ObjectAccessControlProjectTeamResponse

    The project team associated with the entity, if any.

    Role string

    The access permission for the entity.

    SelfLink 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.
    EntityId 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.

    ProjectTeam ObjectAccessControlProjectTeamResponse

    The project team associated with the entity, if any.

    Role string

    The access permission for the entity.

    SelfLink 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.
    entityId 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.

    projectTeam ObjectAccessControlProjectTeamResponse

    The project team associated with the entity, if any.

    role String

    The access permission for the entity.

    selfLink 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.
    entityId 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.

    projectTeam ObjectAccessControlProjectTeamResponse

    The project team associated with the entity, if any.

    role string

    The access permission for the entity.

    selfLink 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 ObjectAccessControlProjectTeamResponse

    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.
    entityId 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.

    projectTeam Property Map

    The project team associated with the entity, if any.

    role String

    The access permission for the entity.

    selfLink String

    The link to this access-control entry.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi