@google-cloud/batch
Version:
973 lines (808 loc) • 1.1 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 batch. */
namespace batch {
/** Namespace v1. */
namespace v1 {
/** Represents a BatchService */
class BatchService extends $protobuf.rpc.Service {
/**
* Constructs a new BatchService 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 BatchService 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): BatchService;
/**
* Calls CreateJob.
* @param request CreateJobRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Job
*/
public createJob(request: google.cloud.batch.v1.ICreateJobRequest, callback: google.cloud.batch.v1.BatchService.CreateJobCallback): void;
/**
* Calls CreateJob.
* @param request CreateJobRequest message or plain object
* @returns Promise
*/
public createJob(request: google.cloud.batch.v1.ICreateJobRequest): Promise<google.cloud.batch.v1.Job>;
/**
* Calls GetJob.
* @param request GetJobRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Job
*/
public getJob(request: google.cloud.batch.v1.IGetJobRequest, callback: google.cloud.batch.v1.BatchService.GetJobCallback): void;
/**
* Calls GetJob.
* @param request GetJobRequest message or plain object
* @returns Promise
*/
public getJob(request: google.cloud.batch.v1.IGetJobRequest): Promise<google.cloud.batch.v1.Job>;
/**
* Calls DeleteJob.
* @param request DeleteJobRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public deleteJob(request: google.cloud.batch.v1.IDeleteJobRequest, callback: google.cloud.batch.v1.BatchService.DeleteJobCallback): void;
/**
* Calls DeleteJob.
* @param request DeleteJobRequest message or plain object
* @returns Promise
*/
public deleteJob(request: google.cloud.batch.v1.IDeleteJobRequest): Promise<google.longrunning.Operation>;
/**
* Calls CancelJob.
* @param request CancelJobRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public cancelJob(request: google.cloud.batch.v1.ICancelJobRequest, callback: google.cloud.batch.v1.BatchService.CancelJobCallback): void;
/**
* Calls CancelJob.
* @param request CancelJobRequest message or plain object
* @returns Promise
*/
public cancelJob(request: google.cloud.batch.v1.ICancelJobRequest): Promise<google.longrunning.Operation>;
/**
* Calls ListJobs.
* @param request ListJobsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListJobsResponse
*/
public listJobs(request: google.cloud.batch.v1.IListJobsRequest, callback: google.cloud.batch.v1.BatchService.ListJobsCallback): void;
/**
* Calls ListJobs.
* @param request ListJobsRequest message or plain object
* @returns Promise
*/
public listJobs(request: google.cloud.batch.v1.IListJobsRequest): Promise<google.cloud.batch.v1.ListJobsResponse>;
/**
* 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.batch.v1.IGetTaskRequest, callback: google.cloud.batch.v1.BatchService.GetTaskCallback): void;
/**
* Calls GetTask.
* @param request GetTaskRequest message or plain object
* @returns Promise
*/
public getTask(request: google.cloud.batch.v1.IGetTaskRequest): Promise<google.cloud.batch.v1.Task>;
/**
* 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.batch.v1.IListTasksRequest, callback: google.cloud.batch.v1.BatchService.ListTasksCallback): void;
/**
* Calls ListTasks.
* @param request ListTasksRequest message or plain object
* @returns Promise
*/
public listTasks(request: google.cloud.batch.v1.IListTasksRequest): Promise<google.cloud.batch.v1.ListTasksResponse>;
}
namespace BatchService {
/**
* Callback as used by {@link google.cloud.batch.v1.BatchService|createJob}.
* @param error Error, if any
* @param [response] Job
*/
type CreateJobCallback = (error: (Error|null), response?: google.cloud.batch.v1.Job) => void;
/**
* Callback as used by {@link google.cloud.batch.v1.BatchService|getJob}.
* @param error Error, if any
* @param [response] Job
*/
type GetJobCallback = (error: (Error|null), response?: google.cloud.batch.v1.Job) => void;
/**
* Callback as used by {@link google.cloud.batch.v1.BatchService|deleteJob}.
* @param error Error, if any
* @param [response] Operation
*/
type DeleteJobCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.batch.v1.BatchService|cancelJob}.
* @param error Error, if any
* @param [response] Operation
*/
type CancelJobCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.batch.v1.BatchService|listJobs}.
* @param error Error, if any
* @param [response] ListJobsResponse
*/
type ListJobsCallback = (error: (Error|null), response?: google.cloud.batch.v1.ListJobsResponse) => void;
/**
* Callback as used by {@link google.cloud.batch.v1.BatchService|getTask}.
* @param error Error, if any
* @param [response] Task
*/
type GetTaskCallback = (error: (Error|null), response?: google.cloud.batch.v1.Task) => void;
/**
* Callback as used by {@link google.cloud.batch.v1.BatchService|listTasks}.
* @param error Error, if any
* @param [response] ListTasksResponse
*/
type ListTasksCallback = (error: (Error|null), response?: google.cloud.batch.v1.ListTasksResponse) => void;
}
/** Properties of a CreateJobRequest. */
interface ICreateJobRequest {
/** CreateJobRequest parent */
parent?: (string|null);
/** CreateJobRequest jobId */
jobId?: (string|null);
/** CreateJobRequest job */
job?: (google.cloud.batch.v1.IJob|null);
/** CreateJobRequest requestId */
requestId?: (string|null);
}
/** Represents a CreateJobRequest. */
class CreateJobRequest implements ICreateJobRequest {
/**
* Constructs a new CreateJobRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.batch.v1.ICreateJobRequest);
/** CreateJobRequest parent. */
public parent: string;
/** CreateJobRequest jobId. */
public jobId: string;
/** CreateJobRequest job. */
public job?: (google.cloud.batch.v1.IJob|null);
/** CreateJobRequest requestId. */
public requestId: string;
/**
* Creates a new CreateJobRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns CreateJobRequest instance
*/
public static create(properties?: google.cloud.batch.v1.ICreateJobRequest): google.cloud.batch.v1.CreateJobRequest;
/**
* Encodes the specified CreateJobRequest message. Does not implicitly {@link google.cloud.batch.v1.CreateJobRequest.verify|verify} messages.
* @param message CreateJobRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.batch.v1.ICreateJobRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified CreateJobRequest message, length delimited. Does not implicitly {@link google.cloud.batch.v1.CreateJobRequest.verify|verify} messages.
* @param message CreateJobRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.batch.v1.ICreateJobRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a CreateJobRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns CreateJobRequest
* @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.batch.v1.CreateJobRequest;
/**
* Decodes a CreateJobRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns CreateJobRequest
* @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.batch.v1.CreateJobRequest;
/**
* Verifies a CreateJobRequest 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 CreateJobRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns CreateJobRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.batch.v1.CreateJobRequest;
/**
* Creates a plain object from a CreateJobRequest message. Also converts values to other types if specified.
* @param message CreateJobRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.batch.v1.CreateJobRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this CreateJobRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for CreateJobRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a GetJobRequest. */
interface IGetJobRequest {
/** GetJobRequest name */
name?: (string|null);
}
/** Represents a GetJobRequest. */
class GetJobRequest implements IGetJobRequest {
/**
* Constructs a new GetJobRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.batch.v1.IGetJobRequest);
/** GetJobRequest name. */
public name: string;
/**
* Creates a new GetJobRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns GetJobRequest instance
*/
public static create(properties?: google.cloud.batch.v1.IGetJobRequest): google.cloud.batch.v1.GetJobRequest;
/**
* Encodes the specified GetJobRequest message. Does not implicitly {@link google.cloud.batch.v1.GetJobRequest.verify|verify} messages.
* @param message GetJobRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.batch.v1.IGetJobRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified GetJobRequest message, length delimited. Does not implicitly {@link google.cloud.batch.v1.GetJobRequest.verify|verify} messages.
* @param message GetJobRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.batch.v1.IGetJobRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a GetJobRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns GetJobRequest
* @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.batch.v1.GetJobRequest;
/**
* Decodes a GetJobRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns GetJobRequest
* @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.batch.v1.GetJobRequest;
/**
* Verifies a GetJobRequest 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 GetJobRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns GetJobRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.batch.v1.GetJobRequest;
/**
* Creates a plain object from a GetJobRequest message. Also converts values to other types if specified.
* @param message GetJobRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.batch.v1.GetJobRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this GetJobRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for GetJobRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a DeleteJobRequest. */
interface IDeleteJobRequest {
/** DeleteJobRequest name */
name?: (string|null);
/** DeleteJobRequest reason */
reason?: (string|null);
/** DeleteJobRequest requestId */
requestId?: (string|null);
}
/** Represents a DeleteJobRequest. */
class DeleteJobRequest implements IDeleteJobRequest {
/**
* Constructs a new DeleteJobRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.batch.v1.IDeleteJobRequest);
/** DeleteJobRequest name. */
public name: string;
/** DeleteJobRequest reason. */
public reason: string;
/** DeleteJobRequest requestId. */
public requestId: string;
/**
* Creates a new DeleteJobRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns DeleteJobRequest instance
*/
public static create(properties?: google.cloud.batch.v1.IDeleteJobRequest): google.cloud.batch.v1.DeleteJobRequest;
/**
* Encodes the specified DeleteJobRequest message. Does not implicitly {@link google.cloud.batch.v1.DeleteJobRequest.verify|verify} messages.
* @param message DeleteJobRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.batch.v1.IDeleteJobRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified DeleteJobRequest message, length delimited. Does not implicitly {@link google.cloud.batch.v1.DeleteJobRequest.verify|verify} messages.
* @param message DeleteJobRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.batch.v1.IDeleteJobRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a DeleteJobRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns DeleteJobRequest
* @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.batch.v1.DeleteJobRequest;
/**
* Decodes a DeleteJobRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns DeleteJobRequest
* @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.batch.v1.DeleteJobRequest;
/**
* Verifies a DeleteJobRequest 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 DeleteJobRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns DeleteJobRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.batch.v1.DeleteJobRequest;
/**
* Creates a plain object from a DeleteJobRequest message. Also converts values to other types if specified.
* @param message DeleteJobRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.batch.v1.DeleteJobRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this DeleteJobRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for DeleteJobRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a CancelJobRequest. */
interface ICancelJobRequest {
/** CancelJobRequest name */
name?: (string|null);
/** CancelJobRequest requestId */
requestId?: (string|null);
}
/** Represents a CancelJobRequest. */
class CancelJobRequest implements ICancelJobRequest {
/**
* Constructs a new CancelJobRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.batch.v1.ICancelJobRequest);
/** CancelJobRequest name. */
public name: string;
/** CancelJobRequest requestId. */
public requestId: string;
/**
* Creates a new CancelJobRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns CancelJobRequest instance
*/
public static create(properties?: google.cloud.batch.v1.ICancelJobRequest): google.cloud.batch.v1.CancelJobRequest;
/**
* Encodes the specified CancelJobRequest message. Does not implicitly {@link google.cloud.batch.v1.CancelJobRequest.verify|verify} messages.
* @param message CancelJobRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.batch.v1.ICancelJobRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified CancelJobRequest message, length delimited. Does not implicitly {@link google.cloud.batch.v1.CancelJobRequest.verify|verify} messages.
* @param message CancelJobRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.batch.v1.ICancelJobRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a CancelJobRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns CancelJobRequest
* @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.batch.v1.CancelJobRequest;
/**
* Decodes a CancelJobRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns CancelJobRequest
* @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.batch.v1.CancelJobRequest;
/**
* Verifies a CancelJobRequest 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 CancelJobRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns CancelJobRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.batch.v1.CancelJobRequest;
/**
* Creates a plain object from a CancelJobRequest message. Also converts values to other types if specified.
* @param message CancelJobRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.batch.v1.CancelJobRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this CancelJobRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for CancelJobRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a CancelJobResponse. */
interface ICancelJobResponse {
}
/** Represents a CancelJobResponse. */
class CancelJobResponse implements ICancelJobResponse {
/**
* Constructs a new CancelJobResponse.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.batch.v1.ICancelJobResponse);
/**
* Creates a new CancelJobResponse instance using the specified properties.
* @param [properties] Properties to set
* @returns CancelJobResponse instance
*/
public static create(properties?: google.cloud.batch.v1.ICancelJobResponse): google.cloud.batch.v1.CancelJobResponse;
/**
* Encodes the specified CancelJobResponse message. Does not implicitly {@link google.cloud.batch.v1.CancelJobResponse.verify|verify} messages.
* @param message CancelJobResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.batch.v1.ICancelJobResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified CancelJobResponse message, length delimited. Does not implicitly {@link google.cloud.batch.v1.CancelJobResponse.verify|verify} messages.
* @param message CancelJobResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.batch.v1.ICancelJobResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a CancelJobResponse message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns CancelJobResponse
* @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.batch.v1.CancelJobResponse;
/**
* Decodes a CancelJobResponse message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns CancelJobResponse
* @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.batch.v1.CancelJobResponse;
/**
* Verifies a CancelJobResponse 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 CancelJobResponse message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns CancelJobResponse
*/
public static fromObject(object: { [k: string]: any }): google.cloud.batch.v1.CancelJobResponse;
/**
* Creates a plain object from a CancelJobResponse message. Also converts values to other types if specified.
* @param message CancelJobResponse
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.batch.v1.CancelJobResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this CancelJobResponse to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for CancelJobResponse
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ListJobsRequest. */
interface IListJobsRequest {
/** ListJobsRequest parent */
parent?: (string|null);
/** ListJobsRequest filter */
filter?: (string|null);
/** ListJobsRequest orderBy */
orderBy?: (string|null);
/** ListJobsRequest pageSize */
pageSize?: (number|null);
/** ListJobsRequest pageToken */
pageToken?: (string|null);
}
/** Represents a ListJobsRequest. */
class ListJobsRequest implements IListJobsRequest {
/**
* Constructs a new ListJobsRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.batch.v1.IListJobsRequest);
/** ListJobsRequest parent. */
public parent: string;
/** ListJobsRequest filter. */
public filter: string;
/** ListJobsRequest orderBy. */
public orderBy: string;
/** ListJobsRequest pageSize. */
public pageSize: number;
/** ListJobsRequest pageToken. */
public pageToken: string;
/**
* Creates a new ListJobsRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns ListJobsRequest instance
*/
public static create(properties?: google.cloud.batch.v1.IListJobsRequest): google.cloud.batch.v1.ListJobsRequest;
/**
* Encodes the specified ListJobsRequest message. Does not implicitly {@link google.cloud.batch.v1.ListJobsRequest.verify|verify} messages.
* @param message ListJobsRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.batch.v1.IListJobsRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ListJobsRequest message, length delimited. Does not implicitly {@link google.cloud.batch.v1.ListJobsRequest.verify|verify} messages.
* @param message ListJobsRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.batch.v1.IListJobsRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a ListJobsRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ListJobsRequest
* @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.batch.v1.ListJobsRequest;
/**
* Decodes a ListJobsRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ListJobsRequest
* @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.batch.v1.ListJobsRequest;
/**
* Verifies a ListJobsRequest 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 ListJobsRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ListJobsRequest
*/
public static fromObject(object: { [k: string]: any }): google.cloud.batch.v1.ListJobsRequest;
/**
* Creates a plain object from a ListJobsRequest message. Also converts values to other types if specified.
* @param message ListJobsRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.batch.v1.ListJobsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ListJobsRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ListJobsRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ListJobsResponse. */
interface IListJobsResponse {
/** ListJobsResponse jobs */
jobs?: (google.cloud.batch.v1.IJob[]|null);
/** ListJobsResponse nextPageToken */
nextPageToken?: (string|null);
/** ListJobsResponse unreachable */
unreachable?: (string[]|null);
}
/** Represents a ListJobsResponse. */
class ListJobsResponse implements IListJobsResponse {
/**
* Constructs a new ListJobsResponse.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.batch.v1.IListJobsResponse);
/** ListJobsResponse jobs. */
public jobs: google.cloud.batch.v1.IJob[];
/** ListJobsResponse nextPageToken. */
public nextPageToken: string;
/** ListJobsResponse unreachable. */
public unreachable: string[];
/**
* Creates a new ListJobsResponse instance using the specified properties.
* @param [properties] Properties to set
* @returns ListJobsResponse instance
*/
public static create(properties?: google.cloud.batch.v1.IListJobsResponse): google.cloud.batch.v1.ListJobsResponse;
/**
* Encodes the specified ListJobsResponse message. Does not implicitly {@link google.cloud.batch.v1.ListJobsResponse.verify|verify} messages.
* @param message ListJobsResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.batch.v1.IListJobsResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ListJobsResponse message, length delimited. Does not implicitly {@link google.cloud.batch.v1.ListJobsResponse.verify|verify} messages.
* @param message ListJobsResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.batch.v1.IListJobsResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a ListJobsResponse message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ListJobsResponse
* @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.batch.v1.ListJobsResponse;
/**
* Decodes a ListJobsResponse message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ListJobsResponse
* @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.batch.v1.ListJobsResponse;
/**
* Verifies a ListJobsResponse 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 ListJobsResponse message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ListJobsResponse
*/
public static fromObject(object: { [k: string]: any }): google.cloud.batch.v1.ListJobsResponse;
/**
* Creates a plain object from a ListJobsResponse message. Also converts values to other types if specified.
* @param message ListJobsResponse
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.batch.v1.ListJobsResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ListJobsResponse to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ListJobsResponse
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ListTasksRequest. */
interface IListTasksRequest {
/** ListTasksRequest parent */
parent?: (string|null);
/** ListTasksRequest filter */
filter?: (string|null);
/** ListTasksRequest pageSize */
pageSize?: (number|null);
/** ListTasksRequest pageToken */
pageToken?: (string|null);
}
/** Represents a ListTasksRequest. */
class ListTasksRequest implements IListTasksRequest {
/**
* Constructs a new ListTasksRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.batch.v1.IListTasksRequest);
/** ListTasksRequest parent. */
public parent: string;
/** ListTasksRequest