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