Represents a WriteObjectSpec.
Package
@google-cloud/storage-controlConstructors
(constructor)(properties)
constructor(properties?: google.storage.v2.IWriteObjectSpec);Constructs a new WriteObjectSpec.
| Parameter | |
|---|---|
| Name | Description |
properties |
IWriteObjectSpec
Properties to set |
Properties
appendable
public appendable?: (boolean|null);WriteObjectSpec appendable.
ifGenerationMatch
public ifGenerationMatch?: (number|Long|string|null);WriteObjectSpec ifGenerationMatch.
ifGenerationNotMatch
public ifGenerationNotMatch?: (number|Long|string|null);WriteObjectSpec ifGenerationNotMatch.
ifMetagenerationMatch
public ifMetagenerationMatch?: (number|Long|string|null);WriteObjectSpec ifMetagenerationMatch.
ifMetagenerationNotMatch
public ifMetagenerationNotMatch?: (number|Long|string|null);WriteObjectSpec ifMetagenerationNotMatch.
objectSize
public objectSize?: (number|Long|string|null);WriteObjectSpec objectSize.
predefinedAcl
public predefinedAcl: string;WriteObjectSpec predefinedAcl.
resource
public resource?: (google.storage.v2.IStorageObject|null);WriteObjectSpec resource.
Methods
create(properties)
public static create(properties?: google.storage.v2.IWriteObjectSpec): google.storage.v2.WriteObjectSpec;Creates a new WriteObjectSpec instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IWriteObjectSpec
Properties to set |
| Returns | |
|---|---|
| Type | Description |
WriteObjectSpec |
WriteObjectSpec instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.storage.v2.WriteObjectSpec;Decodes a WriteObjectSpec message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
WriteObjectSpec |
WriteObjectSpec |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.storage.v2.WriteObjectSpec;Decodes a WriteObjectSpec message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
WriteObjectSpec |
WriteObjectSpec |
encode(message, writer)
public static encode(message: google.storage.v2.IWriteObjectSpec, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified WriteObjectSpec message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IWriteObjectSpec
WriteObjectSpec message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.storage.v2.IWriteObjectSpec, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified WriteObjectSpec message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IWriteObjectSpec
WriteObjectSpec message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.storage.v2.WriteObjectSpec;Creates a WriteObjectSpec message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
WriteObjectSpec |
WriteObjectSpec |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for WriteObjectSpec
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this WriteObjectSpec to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.storage.v2.WriteObjectSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a WriteObjectSpec message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
WriteObjectSpec
WriteObjectSpec |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a WriteObjectSpec message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|