Represents a ReadObjectRequest.
Package
@google-cloud/storage-controlConstructors
(constructor)(properties)
constructor(properties?: google.storage.v2.IReadObjectRequest);Constructs a new ReadObjectRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IReadObjectRequest
Properties to set |
Properties
bucket
public bucket: string;ReadObjectRequest bucket.
commonObjectRequestParams
public commonObjectRequestParams?: (google.storage.v2.ICommonObjectRequestParams|null);ReadObjectRequest commonObjectRequestParams.
generation
public generation: (number|Long|string);ReadObjectRequest generation.
ifGenerationMatch
public ifGenerationMatch?: (number|Long|string|null);ReadObjectRequest ifGenerationMatch.
ifGenerationNotMatch
public ifGenerationNotMatch?: (number|Long|string|null);ReadObjectRequest ifGenerationNotMatch.
ifMetagenerationMatch
public ifMetagenerationMatch?: (number|Long|string|null);ReadObjectRequest ifMetagenerationMatch.
ifMetagenerationNotMatch
public ifMetagenerationNotMatch?: (number|Long|string|null);ReadObjectRequest ifMetagenerationNotMatch.
object
public object: string;ReadObjectRequest object.
readLimit
public readLimit: (number|Long|string);ReadObjectRequest readLimit.
readMask
public readMask?: (google.protobuf.IFieldMask|null);ReadObjectRequest readMask.
readOffset
public readOffset: (number|Long|string);ReadObjectRequest readOffset.
Methods
create(properties)
public static create(properties?: google.storage.v2.IReadObjectRequest): google.storage.v2.ReadObjectRequest;Creates a new ReadObjectRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IReadObjectRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ReadObjectRequest |
ReadObjectRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.storage.v2.ReadObjectRequest;Decodes a ReadObjectRequest 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 |
ReadObjectRequest |
ReadObjectRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.storage.v2.ReadObjectRequest;Decodes a ReadObjectRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ReadObjectRequest |
ReadObjectRequest |
encode(message, writer)
public static encode(message: google.storage.v2.IReadObjectRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ReadObjectRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IReadObjectRequest
ReadObjectRequest 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.IReadObjectRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ReadObjectRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IReadObjectRequest
ReadObjectRequest 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.ReadObjectRequest;Creates a ReadObjectRequest 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 |
ReadObjectRequest |
ReadObjectRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ReadObjectRequest
| 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 ReadObjectRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.storage.v2.ReadObjectRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ReadObjectRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ReadObjectRequest
ReadObjectRequest |
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 ReadObjectRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|