@google-cloud/tasks
Version:
Cloud Tasks API client for Node.js
945 lines (794 loc) • 1.08 MB
TypeScript
// Copyright 2025 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.
import type {protobuf as $protobuf} from "google-gax";
import Long = require("long");
/** Namespace google. */
export namespace google {
/** Namespace cloud. */
namespace cloud {
/** Namespace tasks. */
namespace tasks {
/** Namespace v2. */
namespace v2 {
/** Represents a CloudTasks */
class CloudTasks extends $protobuf.rpc.Service {
/**
* Constructs a new CloudTasks service.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
*/
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
/**
* Creates new CloudTasks service using the specified rpc implementation.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
* @returns RPC service. Useful where requests and/or responses are streamed.
*/
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CloudTasks;
/**
* Calls ListQueues.
* @param request ListQueuesRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListQueuesResponse
*/
public listQueues(request: google.cloud.tasks.v2.IListQueuesRequest, callback: google.cloud.tasks.v2.CloudTasks.ListQueuesCallback): void;
/**
* Calls ListQueues.
* @param request ListQueuesRequest message or plain object
* @returns Promise
*/
public listQueues(request: google.cloud.tasks.v2.IListQueuesRequest): Promise<google.cloud.tasks.v2.ListQueuesResponse>;
/**
* Calls GetQueue.
* @param request GetQueueRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Queue
*/
public getQueue(request: google.cloud.tasks.v2.IGetQueueRequest, callback: google.cloud.tasks.v2.CloudTasks.GetQueueCallback): void;
/**
* Calls GetQueue.
* @param request GetQueueRequest message or plain object
* @returns Promise
*/
public getQueue(request: google.cloud.tasks.v2.IGetQueueRequest): Promise<google.cloud.tasks.v2.Queue>;
/**
* Calls CreateQueue.
* @param request CreateQueueRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Queue
*/
public createQueue(request: google.cloud.tasks.v2.ICreateQueueRequest, callback: google.cloud.tasks.v2.CloudTasks.CreateQueueCallback): void;
/**
* Calls CreateQueue.
* @param request CreateQueueRequest message or plain object
* @returns Promise
*/
public createQueue(request: google.cloud.tasks.v2.ICreateQueueRequest): Promise<google.cloud.tasks.v2.Queue>;
/**
* Calls UpdateQueue.
* @param request UpdateQueueRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Queue
*/
public updateQueue(request: google.cloud.tasks.v2.IUpdateQueueRequest, callback: google.cloud.tasks.v2.CloudTasks.UpdateQueueCallback): void;
/**
* Calls UpdateQueue.
* @param request UpdateQueueRequest message or plain object
* @returns Promise
*/
public updateQueue(request: google.cloud.tasks.v2.IUpdateQueueRequest): Promise<google.cloud.tasks.v2.Queue>;
/**
* Calls DeleteQueue.
* @param request DeleteQueueRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Empty
*/
public deleteQueue(request: google.cloud.tasks.v2.IDeleteQueueRequest, callback: google.cloud.tasks.v2.CloudTasks.DeleteQueueCallback): void;
/**
* Calls DeleteQueue.
* @param request DeleteQueueRequest message or plain object
* @returns Promise
*/
public deleteQueue(request: google.cloud.tasks.v2.IDeleteQueueRequest): Promise<google.protobuf.Empty>;
/**
* Calls PurgeQueue.
* @param request PurgeQueueRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Queue
*/
public purgeQueue(request: google.cloud.tasks.v2.IPurgeQueueRequest, callback: google.cloud.tasks.v2.CloudTasks.PurgeQueueCallback): void;
/**
* Calls PurgeQueue.
* @param request PurgeQueueRequest message or plain object
* @returns Promise
*/
public purgeQueue(request: google.cloud.tasks.v2.IPurgeQueueRequest): Promise<google.cloud.tasks.v2.Queue>;
/**
* Calls PauseQueue.
* @param request PauseQueueRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Queue
*/
public pauseQueue(request: google.cloud.tasks.v2.IPauseQueueRequest, callback: google.cloud.tasks.v2.CloudTasks.PauseQueueCallback): void;
/**
* Calls PauseQueue.
* @param request PauseQueueRequest message or plain object
* @returns Promise
*/
public pauseQueue(request: google.cloud.tasks.v2.IPauseQueueRequest): Promise<google.cloud.tasks.v2.Queue>;
/**
* Calls ResumeQueue.
* @param request ResumeQueueRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Queue
*/
public resumeQueue(request: google.cloud.tasks.v2.IResumeQueueRequest, callback: google.cloud.tasks.v2.CloudTasks.ResumeQueueCallback): void;
/**
* Calls ResumeQueue.
* @param request ResumeQueueRequest message or plain object
* @returns Promise
*/
public resumeQueue(request: google.cloud.tasks.v2.IResumeQueueRequest): Promise<google.cloud.tasks.v2.Queue>;
/**
* Calls GetIamPolicy.
* @param request GetIamPolicyRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Policy
*/
public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.cloud.tasks.v2.CloudTasks.GetIamPolicyCallback): void;
/**
* Calls GetIamPolicy.
* @param request GetIamPolicyRequest message or plain object
* @returns Promise
*/
public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;
/**
* Calls SetIamPolicy.
* @param request SetIamPolicyRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Policy
*/
public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.cloud.tasks.v2.CloudTasks.SetIamPolicyCallback): void;
/**
* Calls SetIamPolicy.
* @param request SetIamPolicyRequest message or plain object
* @returns Promise
*/
public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;
/**
* Calls TestIamPermissions.
* @param request TestIamPermissionsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and TestIamPermissionsResponse
*/
public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.cloud.tasks.v2.CloudTasks.TestIamPermissionsCallback): void;
/**
* Calls TestIamPermissions.
* @param request TestIamPermissionsRequest message or plain object
* @returns Promise
*/
public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;
/**
* Calls ListTasks.
* @param request ListTasksRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListTasksResponse
*/
public listTasks(request: google.cloud.tasks.v2.IListTasksRequest, callback: google.cloud.tasks.v2.CloudTasks.ListTasksCallback): void;
/**
* Calls ListTasks.
* @param request ListTasksRequest message or plain object
* @returns Promise
*/
public listTasks(request: google.cloud.tasks.v2.IListTasksRequest): Promise<google.cloud.tasks.v2.ListTasksResponse>;
/**
* Calls GetTask.
* @param request GetTaskRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Task
*/
public getTask(request: google.cloud.tasks.v2.IGetTaskRequest, callback: google.cloud.tasks.v2.CloudTasks.GetTaskCallback): void;
/**
* Calls GetTask.
* @param request GetTaskRequest message or plain object
* @returns Promise
*/
public getTask(request: google.cloud.tasks.v2.IGetTaskRequest): Promise<google.cloud.tasks.v2.Task>;
/**
* Calls CreateTask.
* @param request CreateTaskRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Task
*/
public createTask(request: google.cloud.tasks.v2.ICreateTaskRequest, callback: google.cloud.tasks.v2.CloudTasks.CreateTaskCallback): void;
/**
* Calls CreateTask.
* @param request CreateTaskRequest message or plain object
* @returns Promise
*/
public createTask(request: google.cloud.tasks.v2.ICreateTaskRequest): Promise<google.cloud.tasks.v2.Task>;
/**
* Calls DeleteTask.
* @param request DeleteTaskRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Empty
*/
public deleteTask(request: google.cloud.tasks.v2.IDeleteTaskRequest, callback: google.cloud.tasks.v2.CloudTasks.DeleteTaskCallback): void;
/**
* Calls DeleteTask.
* @param request DeleteTaskRequest message or plain object
* @returns Promise
*/
public deleteTask(request: google.cloud.tasks.v2.IDeleteTaskRequest): Promise<google.protobuf.Empty>;
/**
* Calls RunTask.
* @param request RunTaskRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Task
*/
public runTask(request: google.cloud.tasks.v2.IRunTaskRequest, callback: google.cloud.tasks.v2.CloudTasks.RunTaskCallback): void;
/**
* Calls RunTask.
* @param request RunTaskRequest message or plain object
* @returns Promise
*/
public runTask(request: google.cloud.tasks.v2.IRunTaskRequest): Promise<google.cloud.tasks.v2.Task>;
}
namespace CloudTasks {
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|listQueues}.
* @param error Error, if any
* @param [response] ListQueuesResponse
*/
type ListQueuesCallback = (error: (Error|null), response?: google.cloud.tasks.v2.ListQueuesResponse) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|getQueue}.
* @param error Error, if any
* @param [response] Queue
*/
type GetQueueCallback = (error: (Error|null), response?: google.cloud.tasks.v2.Queue) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|createQueue}.
* @param error Error, if any
* @param [response] Queue
*/
type CreateQueueCallback = (error: (Error|null), response?: google.cloud.tasks.v2.Queue) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|updateQueue}.
* @param error Error, if any
* @param [response] Queue
*/
type UpdateQueueCallback = (error: (Error|null), response?: google.cloud.tasks.v2.Queue) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|deleteQueue}.
* @param error Error, if any
* @param [response] Empty
*/
type DeleteQueueCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|purgeQueue}.
* @param error Error, if any
* @param [response] Queue
*/
type PurgeQueueCallback = (error: (Error|null), response?: google.cloud.tasks.v2.Queue) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|pauseQueue}.
* @param error Error, if any
* @param [response] Queue
*/
type PauseQueueCallback = (error: (Error|null), response?: google.cloud.tasks.v2.Queue) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|resumeQueue}.
* @param error Error, if any
* @param [response] Queue
*/
type ResumeQueueCallback = (error: (Error|null), response?: google.cloud.tasks.v2.Queue) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|getIamPolicy}.
* @param error Error, if any
* @param [response] Policy
*/
type GetIamPolicyCallback = (error: (Error|null), response?: google.iam.v1.Policy) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|setIamPolicy}.
* @param error Error, if any
* @param [response] Policy
*/
type SetIamPolicyCallback = (error: (Error|null), response?: google.iam.v1.Policy) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|testIamPermissions}.
* @param error Error, if any
* @param [response] TestIamPermissionsResponse
*/
type TestIamPermissionsCallback = (error: (Error|null), response?: google.iam.v1.TestIamPermissionsResponse) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|listTasks}.
* @param error Error, if any
* @param [response] ListTasksResponse
*/
type ListTasksCallback = (error: (Error|null), response?: google.cloud.tasks.v2.ListTasksResponse) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|getTask}.
* @param error Error, if any
* @param [response] Task
*/
type GetTaskCallback = (error: (Error|null), response?: google.cloud.tasks.v2.Task) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|createTask}.
* @param error Error, if any
* @param [response] Task
*/
type CreateTaskCallback = (error: (Error|null), response?: google.cloud.tasks.v2.Task) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|deleteTask}.
* @param error Error, if any
* @param [response] Empty
*/
type DeleteTaskCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;
/**
* Callback as used by {@link google.cloud.tasks.v2.CloudTasks|runTask}.
* @param error Error, if any
* @param [response] Task
*/
type RunTaskCallback = (error: (Error|null), response?: google.cloud.tasks.v2.Task) => void;
}
/** Properties of a ListQueuesRequest. */
interface IListQueuesRequest {
/** ListQueuesRequest parent */
parent?: (string|null);
/** ListQueuesRequest filter */
filter?: (string|null);
/** ListQueuesRequest pageSize */
pageSize?: (number|null);
/** ListQueuesRequest pageToken */
pageToken?: (string|null);
}
/** Represents a ListQueuesRequest. */
class ListQueuesRequest implements IListQueuesRequest {
/**
* Constructs a new ListQueuesRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.tasks.v2.IListQueuesRequest);
/** ListQueuesRequest parent. */
public parent: string;
/** ListQueuesRequest filter. */
public filter: string;
/** ListQueuesRequest pageSize. */
public pageSize: number;
/** ListQueuesRequest pageToken. */
public pageToken: string;
/**
* Creates a new ListQueuesRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns ListQueuesRequest instance
*/
public static create(properties?: google.cloud.tasks.v2.IListQueuesRequest): google.cloud.tasks.v2.ListQueuesRequest;
/**
* Encodes the specified ListQueuesRequest message. Does not implicitly {@link google.cloud.tasks.v2.ListQueuesRequest.verify|verify} messages.
* @param message ListQueuesRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.tasks.v2.IListQueuesRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ListQueuesRequest message, length delimited. Does not implicitly {@link google.cloud.tasks.v2.ListQueuesRequest.verify|verify} messages.
* @param message ListQueuesRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.tasks.v2.IListQueuesRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a ListQueuesRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ListQueuesRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tasks.v2.ListQueuesRequest;
/**
* Decodes a ListQueuesRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ListQueuesRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tasks.v2.ListQueuesRequest;
/**
* Verifies a ListQueuesRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a ListQueuesRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ListQueuesRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.tasks.v2.ListQueuesRequest;
/**
* Creates a plain object from a ListQueuesRequest message. Also converts values to other types if specified.
* @param message ListQueuesRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.tasks.v2.ListQueuesRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ListQueuesRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ListQueuesRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ListQueuesResponse. */
interface IListQueuesResponse {
/** ListQueuesResponse queues */
queues?: (google.cloud.tasks.v2.IQueue[]|null);
/** ListQueuesResponse nextPageToken */
nextPageToken?: (string|null);
}
/** Represents a ListQueuesResponse. */
class ListQueuesResponse implements IListQueuesResponse {
/**
* Constructs a new ListQueuesResponse.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.tasks.v2.IListQueuesResponse);
/** ListQueuesResponse queues. */
public queues: google.cloud.tasks.v2.IQueue[];
/** ListQueuesResponse nextPageToken. */
public nextPageToken: string;
/**
* Creates a new ListQueuesResponse instance using the specified properties.
* @param [properties] Properties to set
* @returns ListQueuesResponse instance
*/
public static create(properties?: google.cloud.tasks.v2.IListQueuesResponse): google.cloud.tasks.v2.ListQueuesResponse;
/**
* Encodes the specified ListQueuesResponse message. Does not implicitly {@link google.cloud.tasks.v2.ListQueuesResponse.verify|verify} messages.
* @param message ListQueuesResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.tasks.v2.IListQueuesResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ListQueuesResponse message, length delimited. Does not implicitly {@link google.cloud.tasks.v2.ListQueuesResponse.verify|verify} messages.
* @param message ListQueuesResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.tasks.v2.IListQueuesResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a ListQueuesResponse message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ListQueuesResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tasks.v2.ListQueuesResponse;
/**
* Decodes a ListQueuesResponse message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ListQueuesResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tasks.v2.ListQueuesResponse;
/**
* Verifies a ListQueuesResponse message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a ListQueuesResponse message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ListQueuesResponse
*/
public static fromObject(object: { [k: string]: any }): google.cloud.tasks.v2.ListQueuesResponse;
/**
* Creates a plain object from a ListQueuesResponse message. Also converts values to other types if specified.
* @param message ListQueuesResponse
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.tasks.v2.ListQueuesResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ListQueuesResponse to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ListQueuesResponse
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a GetQueueRequest. */
interface IGetQueueRequest {
/** GetQueueRequest name */
name?: (string|null);
}
/** Represents a GetQueueRequest. */
class GetQueueRequest implements IGetQueueRequest {
/**
* Constructs a new GetQueueRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.tasks.v2.IGetQueueRequest);
/** GetQueueRequest name. */
public name: string;
/**
* Creates a new GetQueueRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns GetQueueRequest instance
*/
public static create(properties?: google.cloud.tasks.v2.IGetQueueRequest): google.cloud.tasks.v2.GetQueueRequest;
/**
* Encodes the specified GetQueueRequest message. Does not implicitly {@link google.cloud.tasks.v2.GetQueueRequest.verify|verify} messages.
* @param message GetQueueRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.tasks.v2.IGetQueueRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified GetQueueRequest message, length delimited. Does not implicitly {@link google.cloud.tasks.v2.GetQueueRequest.verify|verify} messages.
* @param message GetQueueRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.tasks.v2.IGetQueueRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a GetQueueRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns GetQueueRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tasks.v2.GetQueueRequest;
/**
* Decodes a GetQueueRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns GetQueueRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tasks.v2.GetQueueRequest;
/**
* Verifies a GetQueueRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a GetQueueRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns GetQueueRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.tasks.v2.GetQueueRequest;
/**
* Creates a plain object from a GetQueueRequest message. Also converts values to other types if specified.
* @param message GetQueueRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.tasks.v2.GetQueueRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this GetQueueRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for GetQueueRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a CreateQueueRequest. */
interface ICreateQueueRequest {
/** CreateQueueRequest parent */
parent?: (string|null);
/** CreateQueueRequest queue */
queue?: (google.cloud.tasks.v2.IQueue|null);
}
/** Represents a CreateQueueRequest. */
class CreateQueueRequest implements ICreateQueueRequest {
/**
* Constructs a new CreateQueueRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.tasks.v2.ICreateQueueRequest);
/** CreateQueueRequest parent. */
public parent: string;
/** CreateQueueRequest queue. */
public queue?: (google.cloud.tasks.v2.IQueue|null);
/**
* Creates a new CreateQueueRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns CreateQueueRequest instance
*/
public static create(properties?: google.cloud.tasks.v2.ICreateQueueRequest): google.cloud.tasks.v2.CreateQueueRequest;
/**
* Encodes the specified CreateQueueRequest message. Does not implicitly {@link google.cloud.tasks.v2.CreateQueueRequest.verify|verify} messages.
* @param message CreateQueueRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.tasks.v2.ICreateQueueRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified CreateQueueRequest message, length delimited. Does not implicitly {@link google.cloud.tasks.v2.CreateQueueRequest.verify|verify} messages.
* @param message CreateQueueRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.tasks.v2.ICreateQueueRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a CreateQueueRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns CreateQueueRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tasks.v2.CreateQueueRequest;
/**
* Decodes a CreateQueueRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns CreateQueueRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tasks.v2.CreateQueueRequest;
/**
* Verifies a CreateQueueRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a CreateQueueRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns CreateQueueRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.tasks.v2.CreateQueueRequest;
/**
* Creates a plain object from a CreateQueueRequest message. Also converts values to other types if specified.
* @param message CreateQueueRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.tasks.v2.CreateQueueRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this CreateQueueRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for CreateQueueRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an UpdateQueueRequest. */
interface IUpdateQueueRequest {
/** UpdateQueueRequest queue */
queue?: (google.cloud.tasks.v2.IQueue|null);
/** UpdateQueueRequest updateMask */
updateMask?: (google.protobuf.IFieldMask|null);
}
/** Represents an UpdateQueueRequest. */
class UpdateQueueRequest implements IUpdateQueueRequest {
/**
* Constructs a new UpdateQueueRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.tasks.v2.IUpdateQueueRequest);
/** UpdateQueueRequest queue. */
public queue?: (google.cloud.tasks.v2.IQueue|null);
/** UpdateQueueRequest updateMask. */
public updateMask?: (google.protobuf.IFieldMask|null);
/**
* Creates a new UpdateQueueRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns UpdateQueueRequest instance
*/
public static create(properties?: google.cloud.tasks.v2.IUpdateQueueRequest): google.cloud.tasks.v2.UpdateQueueRequest;
/**
* Encodes the specified UpdateQueueRequest message. Does not implicitly {@link google.cloud.tasks.v2.UpdateQueueRequest.verify|verify} messages.
* @param message UpdateQueueRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.tasks.v2.IUpdateQueueRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified UpdateQueueRequest message, length delimited. Does not implicitly {@link google.cloud.tasks.v2.UpdateQueueRequest.verify|verify} messages.
* @param message UpdateQueueRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.tasks.v2.IUpdateQueueRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an UpdateQueueRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns UpdateQueueRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tasks.v2.UpdateQueueRequest;
/**
* Decodes an UpdateQueueRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns UpdateQueueRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tasks.v2.UpdateQueueRequest;
/**
* Verifies an UpdateQueueRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an UpdateQueueRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns UpdateQueueRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.tasks.v2.UpdateQueueRequest;
/**
* Creates a plain object from an UpdateQueueRequest message. Also converts values to other types if specified.
* @param message UpdateQueueRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.tasks.v2.UpdateQueueRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this UpdateQueueRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for UpdateQueueRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a DeleteQueueRequest. */
interface IDeleteQueueRequest {
/** DeleteQueueRequest name */
name?: (string|null);
}
/** Represents a DeleteQueueRequest. */
class DeleteQueueRequest implements IDeleteQueueRequest {
/**
* Constructs a new DeleteQueueRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.tasks.v2.IDeleteQueueRequest);
/** DeleteQueueRequest name. */
public name: string;
/**
* Creates a new DeleteQueueRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns DeleteQueueRequest instance
*/
public static create(properties?: google.cloud.tasks.v2.IDeleteQueueRequest): google.cloud.tasks.v2.DeleteQueueRequest;
/**
* Encodes the specified DeleteQueueRequest message. Does not implicitly {@link google.cloud.tasks.v2.DeleteQueueRequest.verify|verify} messages.
* @param message DeleteQueueRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.tasks.v2.IDeleteQueueRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified DeleteQueueRequest message, length delim