/
StorageObjectData.ts
212 lines (180 loc) · 5.12 KB
/
StorageObjectData.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/* eslint-disable @typescript-eslint/no-explicit-any*/
/**
* An object within Google Cloud Storage.
*
* @public
*/
export interface StorageObjectData {
/**
* Content-Encoding of the object data, matching
* [https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
*/
contentEncoding: string;
/**
* Content-Disposition of the object data, matching
* [https://tools.ietf.org/html/rfc6266][RFC 6266].
*/
contentDisposition: string;
/**
* Cache-Control directive for the object data, matching
* [https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §5.2].
*/
cacheControl: string;
/**
* Content-Language of the object data, matching
* [https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
*/
contentLanguage: 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.
*/
metageneration: number;
/**
* The deletion time of the object. Will be returned if and only if this
* version of the object has been deleted.
*/
timeDeleted: string;
/**
* Content-Type of the object data, matching
* [https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5].
* If an object is stored without a Content-Type, it is served as
* `application/octet-stream`.
*/
contentType: string;
/**
* Content-Length of the object data in bytes, matching
* [https://tools.ietf.org/html/rfc7230#section-3.3.2][RFC 7230 §3.3.2].
*/
size: number;
/**
* The creation time of the object.
* Attempting to set this field will result in an error.
*/
timeCreated: string;
/**
* CRC32c checksum. For more information about using the CRC32c
* checksum, see
* [https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI][Hashes and
* ETags: Best Practices].
*/
crc32c: string;
/**
* Number of underlying components that make up this object. Components are
* accumulated by compose operations.
* Attempting to set this field will result in an error.
*/
componentCount: number;
/**
* MD5 hash of the data; encoded using base64 as per
* [https://tools.ietf.org/html/rfc4648#section-4][RFC 4648 §4]. For more
* information about using the MD5 hash, see
* [https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI][Hashes and
* ETags: Best Practices].
*/
md5Hash: string;
/**
* HTTP 1.1 Entity tag for the object. See
* [https://tools.ietf.org/html/rfc7232#section-2.3][RFC 7232 §2.3].
*/
etag: string;
/**
* The modification time of the object metadata.
*/
updated: string;
/**
* Storage class of the object.
*/
storageClass: string;
/**
* Cloud KMS Key used to encrypt this object, if the object is encrypted by
* such a key.
*/
kmsKeyName: string;
/**
* The time at which the object's storage class was last changed.
*/
timeStorageClassUpdated: string;
/**
* Whether an object is under temporary hold.
*/
temporaryHold: boolean;
/**
* A server-determined value that specifies the earliest time that the
* object's retention period expires.
*/
retentionExpirationTime: string;
/**
* User-provided metadata, in key/value pairs.
*/
metadata: object;
/**
* Whether an object is under event-based hold.
*/
eventBasedHold: boolean;
/**
* The name of the object.
*/
name: string;
/**
* The ID of the object, including the bucket name, object name, and
* generation number.
*/
id: string;
/**
* The name of the bucket containing this object.
*/
bucket: string;
/**
* The content generation of this object. Used for object versioning.
* Attempting to set this field will result in an error.
*/
generation: number;
/**
* Metadata of customer-supplied encryption key, if the object is encrypted by
* such a key.
*/
customerEncryption: CustomerEncryption;
/**
* Media download link.
*/
mediaLink: string;
/**
* The link to this object.
*/
selfLink: string;
/**
* The kind of item this is. For objects, this is always "storage#object".
*/
kind: string;
}
/**
* Describes the customer-specified mechanism used to store the data at rest.
*
* @public
*/
export interface CustomerEncryption {
/**
* The encryption algorithm.
*/
encryptionAlgorithm: string;
/**
* SHA256 hash value of the encryption key.
*/
keySha256: string;
}