googleapis
Version:
Google APIs Client Library for Node.js
1,218 lines • 84.2 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace cloudsupport_v2beta {
export interface Options extends GlobalOptions {
version: 'v2beta';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Google Cloud Support API
*
* Manages Google Cloud technical support cases for Customer Care support offerings.
*
* @example
* ```js
* const {google} = require('googleapis');
* const cloudsupport = google.cloudsupport('v2beta');
* ```
*/
export class Cloudsupport {
context: APIRequestContext;
attachments: Resource$Attachments;
caseClassifications: Resource$Caseclassifications;
cases: Resource$Cases;
media: Resource$Media;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An object containing information about the effective user and authenticated principal responsible for an action.
*/
export interface Schema$Actor {
/**
* The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
*/
displayName?: string | null;
/**
* The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.
*/
email?: string | null;
/**
* Output only. Whether the actor is a Google support actor.
*/
googleSupport?: boolean | null;
}
/**
* Represents a file attached to a support case.
*/
export interface Schema$Attachment {
/**
* Output only. The time at which the attachment was created.
*/
createTime?: string | null;
/**
* Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.
*/
creator?: Schema$Actor;
/**
* The filename of the attachment (e.g. `"graph.jpg"`).
*/
filename?: string | null;
/**
* Output only. The MIME type of the attachment (e.g. text/plain).
*/
mimeType?: string | null;
/**
* Output only. The resource name of the attachment.
*/
name?: string | null;
/**
* Output only. The size of the attachment in bytes.
*/
sizeBytes?: string | null;
}
/**
* # gdata.* are outside protos with mising documentation
*/
export interface Schema$Blobstore2Info {
/**
* # gdata.* are outside protos with mising documentation
*/
blobGeneration?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
blobId?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
downloadReadHandle?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
readToken?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
uploadMetadataContainer?: string | null;
}
/**
* A support case.
*/
export interface Schema$Case {
/**
* The issue classification applicable to this case.
*/
classification?: Schema$CaseClassification;
/**
* Output only. The time this case was created.
*/
createTime?: string | null;
/**
* The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support.
*/
creator?: Schema$Actor;
/**
* A broad description of the issue.
*/
description?: string | null;
/**
* The short summary of the issue reported in this case.
*/
displayName?: string | null;
/**
* Whether the case is currently escalated.
*/
escalated?: boolean | null;
/**
* The resource name for the case.
*/
name?: string | null;
/**
* The priority of this case. If this is set, do not set severity.
*/
priority?: string | null;
/**
* The severity of this case. Deprecated. Use priority instead.
*/
severity?: string | null;
/**
* Output only. The current status of the support case.
*/
state?: string | null;
/**
* The email addresses to receive updates on this case.
*/
subscriberEmailAddresses?: string[] | null;
/**
* Whether this case was created for internal API testing and should not be acted on by the support team.
*/
testCase?: boolean | null;
/**
* The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.
*/
timeZone?: string | null;
/**
* Output only. The time this case was last updated.
*/
updateTime?: string | null;
}
/**
* A classification object with a product type and value.
*/
export interface Schema$CaseClassification {
/**
* The display name of the classification.
*/
displayName?: string | null;
/**
* The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`.
*/
id?: string | null;
}
/**
* The request message for the CloseCase endpoint.
*/
export interface Schema$CloseCaseRequest {
}
/**
* A comment associated with a support case.
*/
export interface Schema$Comment {
/**
* The full comment body. Maximum of 120000 characters. This can contain rich text syntax.
*/
body?: string | null;
/**
* Output only. The time when this comment was created.
*/
createTime?: string | null;
/**
* Output only. The user or Google Support agent created this comment.
*/
creator?: Schema$Actor;
/**
* Output only. The resource name for the comment.
*/
name?: string | null;
/**
* Output only. An automatically generated plain text version of body with all rich text syntax stripped.
*/
plainTextBody?: string | null;
}
/**
* # gdata.* are outside protos with mising documentation
*/
export interface Schema$CompositeMedia {
/**
* # gdata.* are outside protos with mising documentation
*/
blobRef?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
blobstore2Info?: Schema$Blobstore2Info;
/**
* # gdata.* are outside protos with mising documentation
*/
cosmoBinaryReference?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
crc32cHash?: number | null;
/**
* # gdata.* are outside protos with mising documentation
*/
inline?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
length?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
md5Hash?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
objectId?: Schema$ObjectId;
/**
* # gdata.* are outside protos with mising documentation
*/
path?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
referenceType?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
sha1Hash?: string | null;
}
/**
* # gdata.* are outside protos with mising documentation
*/
export interface Schema$ContentTypeInfo {
/**
* # gdata.* are outside protos with mising documentation
*/
bestGuess?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
fromBytes?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
fromFileName?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
fromHeader?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
fromUrlPath?: string | null;
}
/**
* The request message for the CreateAttachment endpoint.
*/
export interface Schema$CreateAttachmentRequest {
/**
* Required. The attachment to be created.
*/
attachment?: Schema$Attachment;
}
/**
* # gdata.* are outside protos with mising documentation
*/
export interface Schema$DiffChecksumsResponse {
/**
* # gdata.* are outside protos with mising documentation
*/
checksumsLocation?: Schema$CompositeMedia;
/**
* # gdata.* are outside protos with mising documentation
*/
chunkSizeBytes?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
objectLocation?: Schema$CompositeMedia;
/**
* # gdata.* are outside protos with mising documentation
*/
objectSizeBytes?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
objectVersion?: string | null;
}
/**
* # gdata.* are outside protos with mising documentation
*/
export interface Schema$DiffDownloadResponse {
/**
* # gdata.* are outside protos with mising documentation
*/
objectLocation?: Schema$CompositeMedia;
}
/**
* # gdata.* are outside protos with mising documentation
*/
export interface Schema$DiffUploadRequest {
/**
* # gdata.* are outside protos with mising documentation
*/
checksumsInfo?: Schema$CompositeMedia;
/**
* # gdata.* are outside protos with mising documentation
*/
objectInfo?: Schema$CompositeMedia;
/**
* # gdata.* are outside protos with mising documentation
*/
objectVersion?: string | null;
}
/**
* # gdata.* are outside protos with mising documentation
*/
export interface Schema$DiffUploadResponse {
/**
* # gdata.* are outside protos with mising documentation
*/
objectVersion?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
originalObject?: Schema$CompositeMedia;
}
/**
* # gdata.* are outside protos with mising documentation
*/
export interface Schema$DiffVersionResponse {
/**
* # gdata.* are outside protos with mising documentation
*/
objectSizeBytes?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
objectVersion?: string | null;
}
/**
* # gdata.* are outside protos with mising documentation
*/
export interface Schema$DownloadParameters {
/**
* # gdata.* are outside protos with mising documentation
*/
allowGzipCompression?: boolean | null;
/**
* # gdata.* are outside protos with mising documentation
*/
ignoreRange?: boolean | null;
}
/**
* The request message for the EscalateCase endpoint.
*/
export interface Schema$EscalateCaseRequest {
/**
* The escalation object to be sent with the escalation request.
*/
escalation?: Schema$Escalation;
}
/**
* An escalation of a support case.
*/
export interface Schema$Escalation {
/**
* Required. A free text description to accompany the `reason` field above. Provides additional context on why the case is being escalated.
*/
justification?: string | null;
/**
* Required. The reason why the Case is being escalated.
*/
reason?: string | null;
}
/**
* The response message for the ListAttachments endpoint.
*/
export interface Schema$ListAttachmentsResponse {
/**
* The list of attachments associated with the given case.
*/
attachments?: Schema$Attachment[];
/**
* A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `cases.attachments.list` requests. If unspecified, there are no more results to retrieve.
*/
nextPageToken?: string | null;
}
/**
* The response message for the ListCases endpoint.
*/
export interface Schema$ListCasesResponse {
/**
* The list of cases associated with the cloud resource, after any filters have been applied.
*/
cases?: Schema$Case[];
/**
* A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `ListCasesRequest` message that is issued. If unspecified, there are no more results to retrieve.
*/
nextPageToken?: string | null;
}
/**
* The response message for the ListComments endpoint.
*/
export interface Schema$ListCommentsResponse {
/**
* The list of Comments associated with the given Case.
*/
comments?: Schema$Comment[];
/**
* A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `ListCommentsRequest` message that is issued. If unspecified, there are no more results to retrieve.
*/
nextPageToken?: string | null;
}
/**
* # gdata.* are outside protos with mising documentation
*/
export interface Schema$Media {
/**
* # gdata.* are outside protos with mising documentation
*/
algorithm?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
bigstoreObjectRef?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
blobRef?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
blobstore2Info?: Schema$Blobstore2Info;
/**
* # gdata.* are outside protos with mising documentation
*/
compositeMedia?: Schema$CompositeMedia[];
/**
* # gdata.* are outside protos with mising documentation
*/
contentType?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
contentTypeInfo?: Schema$ContentTypeInfo;
/**
* # gdata.* are outside protos with mising documentation
*/
cosmoBinaryReference?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
crc32cHash?: number | null;
/**
* # gdata.* are outside protos with mising documentation
*/
diffChecksumsResponse?: Schema$DiffChecksumsResponse;
/**
* # gdata.* are outside protos with mising documentation
*/
diffDownloadResponse?: Schema$DiffDownloadResponse;
/**
* # gdata.* are outside protos with mising documentation
*/
diffUploadRequest?: Schema$DiffUploadRequest;
/**
* # gdata.* are outside protos with mising documentation
*/
diffUploadResponse?: Schema$DiffUploadResponse;
/**
* # gdata.* are outside protos with mising documentation
*/
diffVersionResponse?: Schema$DiffVersionResponse;
/**
* # gdata.* are outside protos with mising documentation
*/
downloadParameters?: Schema$DownloadParameters;
/**
* # gdata.* are outside protos with mising documentation
*/
filename?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
hash?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
hashVerified?: boolean | null;
/**
* # gdata.* are outside protos with mising documentation
*/
inline?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
isPotentialRetry?: boolean | null;
/**
* # gdata.* are outside protos with mising documentation
*/
length?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
md5Hash?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
mediaId?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
objectId?: Schema$ObjectId;
/**
* # gdata.* are outside protos with mising documentation
*/
path?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
referenceType?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
sha1Hash?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
sha256Hash?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
timestamp?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
token?: string | null;
}
/**
* # gdata.* are outside protos with mising documentation
*/
export interface Schema$ObjectId {
/**
* # gdata.* are outside protos with mising documentation
*/
bucketName?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
generation?: string | null;
/**
* # gdata.* are outside protos with mising documentation
*/
objectName?: string | null;
}
/**
* The response message for SearchCaseClassifications endpoint.
*/
export interface Schema$SearchCaseClassificationsResponse {
/**
* The classifications retrieved.
*/
caseClassifications?: Schema$CaseClassification[];
/**
* A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `SearchCaseClassificationsRequest` message that is issued. If unspecified, there are no more results to retrieve.
*/
nextPageToken?: string | null;
}
/**
* The response message for the SearchCases endpoint.
*/
export interface Schema$SearchCasesResponse {
/**
* The list of Case associated with the cloud resource, after any filters have been applied.
*/
cases?: Schema$Case[];
/**
* A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `SearchCaseRequest` message that is issued. If unspecified, there are no more results to retrieve.
*/
nextPageToken?: string | null;
}
/**
* Metadata about the operation. Used to lookup the current status.
*/
export interface Schema$WorkflowOperationMetadata {
/**
* The namespace that the job was scheduled in. Must be included in the workflow metadata so the workflow status can be retrieved.
*/
namespace?: string | null;
/**
* The type of action the operation is classified as.
*/
operationAction?: string | null;
/**
* Which version of the workflow service this operation came from.
*/
workflowOperationType?: string | null;
}
export class Resource$Attachments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Create a file attachment on a case or Cloud resource.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudsupport.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudsupport = google.cloudsupport('v2beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudsupport.attachments.create({
* // Required. The resource name of the case to which attachment should be attached.
* parent: '[^/]+/[^/]+',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "attachment": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "createTime": "my_createTime",
* // "creator": {},
* // "filename": "my_filename",
* // "mimeType": "my_mimeType",
* // "name": "my_name",
* // "sizeBytes": "my_sizeBytes"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Attachments$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Attachments$Create, options?: MethodOptions): GaxiosPromise<Schema$Attachment>;
create(params: Params$Resource$Attachments$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Attachments$Create, options: MethodOptions | BodyResponseCallback<Schema$Attachment>, callback: BodyResponseCallback<Schema$Attachment>): void;
create(params: Params$Resource$Attachments$Create, callback: BodyResponseCallback<Schema$Attachment>): void;
create(callback: BodyResponseCallback<Schema$Attachment>): void;
}
export interface Params$Resource$Attachments$Create extends StandardParameters {
/**
* Required. The resource name of the case to which attachment should be attached.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CreateAttachmentRequest;
}
export class Resource$Caseclassifications {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Retrieve valid classifications to be used when creating a support case. The classications are hierarchical, with each classification containing all levels of the hierarchy, separated by " \> ". For example "Technical Issue \> Compute \> Compute Engine".
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudsupport.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudsupport = google.cloudsupport('v2beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudsupport.caseClassifications.search({
* // The maximum number of cases fetched with each request.
* pageSize: 'placeholder-value',
* // A token identifying the page of results to return. If unspecified, the first page is retrieved.
* pageToken: 'placeholder-value',
* // An expression written in the Cloud filter language. If non-empty, then only cases whose fields match the filter are returned. If empty, then no messages are filtered out.
* query: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "caseClassifications": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
search(params: Params$Resource$Caseclassifications$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
search(params?: Params$Resource$Caseclassifications$Search, options?: MethodOptions): GaxiosPromise<Schema$SearchCaseClassificationsResponse>;
search(params: Params$Resource$Caseclassifications$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
search(params: Params$Resource$Caseclassifications$Search, options: MethodOptions | BodyResponseCallback<Schema$SearchCaseClassificationsResponse>, callback: BodyResponseCallback<Schema$SearchCaseClassificationsResponse>): void;
search(params: Params$Resource$Caseclassifications$Search, callback: BodyResponseCallback<Schema$SearchCaseClassificationsResponse>): void;
search(callback: BodyResponseCallback<Schema$SearchCaseClassificationsResponse>): void;
}
export interface Params$Resource$Caseclassifications$Search extends StandardParameters {
/**
* The maximum number of cases fetched with each request.
*/
pageSize?: number;
/**
* A token identifying the page of results to return. If unspecified, the first page is retrieved.
*/
pageToken?: string;
/**
* An expression written in the Cloud filter language. If non-empty, then only cases whose fields match the filter are returned. If empty, then no messages are filtered out.
*/
query?: string;
}
export class Resource$Cases {
context: APIRequestContext;
attachments: Resource$Cases$Attachments;
comments: Resource$Cases$Comments;
constructor(context: APIRequestContext);
/**
* Close the specified case.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudsupport.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudsupport = google.cloudsupport('v2beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudsupport.cases.close({
* // Required. The fully qualified name of the case resource to be closed.
* name: '[^/]+/[^/]+/cases/my-case',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {}
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "classification": {},
* // "createTime": "my_createTime",
* // "creator": {},
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "escalated": false,
* // "name": "my_name",
* // "priority": "my_priority",
* // "severity": "my_severity",
* // "state": "my_state",
* // "subscriberEmailAddresses": [],
* // "testCase": false,
* // "timeZone": "my_timeZone",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
close(params: Params$Resource$Cases$Close, options: StreamMethodOptions): GaxiosPromise<Readable>;
close(params?: Params$Resource$Cases$Close, options?: MethodOptions): GaxiosPromise<Schema$Case>;
close(params: Params$Resource$Cases$Close, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
close(params: Params$Resource$Cases$Close, options: MethodOptions | BodyResponseCallback<Schema$Case>, callback: BodyResponseCallback<Schema$Case>): void;
close(params: Params$Resource$Cases$Close, callback: BodyResponseCallback<Schema$Case>): void;
close(callback: BodyResponseCallback<Schema$Case>): void;
/**
* Create a new case and associate it with the given Cloud resource.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudsupport.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudsupport = google.cloudsupport('v2beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudsupport.cases.create({
* // Required. The name of the Cloud resource under which the case should be created.
* parent: '[^/]+/[^/]+',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "classification": {},
* // "createTime": "my_createTime",
* // "creator": {},
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "escalated": false,
* // "name": "my_name",
* // "priority": "my_priority",
* // "severity": "my_severity",
* // "state": "my_state",
* // "subscriberEmailAddresses": [],
* // "testCase": false,
* // "timeZone": "my_timeZone",
* // "updateTime": "my_updateTime"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "classification": {},
* // "createTime": "my_createTime",
* // "creator": {},
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "escalated": false,
* // "name": "my_name",
* // "priority": "my_priority",
* // "severity": "my_severity",
* // "state": "my_state",
* // "subscriberEmailAddresses": [],
* // "testCase": false,
* // "timeZone": "my_timeZone",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Cases$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Cases$Create, options?: MethodOptions): GaxiosPromise<Schema$Case>;
create(params: Params$Resource$Cases$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Cases$Create, options: MethodOptions | BodyResponseCallback<Schema$Case>, callback: BodyResponseCallback<Schema$Case>): void;
create(params: Params$Resource$Cases$Create, callback: BodyResponseCallback<Schema$Case>): void;
create(callback: BodyResponseCallback<Schema$Case>): void;
/**
* Escalate a case. Escalating a case will initiate the Cloud Support escalation management process. This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudsupport.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudsupport = google.cloudsupport('v2beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudsupport.cases.escalate({
* // Required. The fully qualified name of the Case resource to be escalated.
* name: '[^/]+/[^/]+/cases/my-case',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "escalation": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "classification": {},
* // "createTime": "my_createTime",
* // "creator": {},
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "escalated": false,
* // "name": "my_name",
* // "priority": "my_priority",
* // "severity": "my_severity",
* // "state": "my_state",
* // "subscriberEmailAddresses": [],
* // "testCase": false,
* // "timeZone": "my_timeZone",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
escalate(params: Params$Resource$Cases$Escalate, options: StreamMethodOptions): GaxiosPromise<Readable>;
escalate(params?: Params$Resource$Cases$Escalate, options?: MethodOptions): GaxiosPromise<Schema$Case>;
escalate(params: Params$Resource$Cases$Escalate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
escalate(params: Params$Resource$Cases$Escalate, options: MethodOptions | BodyResponseCallback<Schema$Case>, callback: BodyResponseCallback<Schema$Case>): void;
escalate(params: Params$Resource$Cases$Escalate, callback: BodyResponseCallback<Schema$Case>): void;
escalate(callback: BodyResponseCallback<Schema$Case>): void;
/**
* Retrieve the specified case.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudsupport.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudsupport = google.cloudsupport('v2beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudsupport.cases.get({
* // Required. The fully qualified name of a case to be retrieved.
* name: '[^/]+/[^/]+/cases/my-case',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "classification": {},
* // "createTime": "my_createTime",
* // "creator": {},
* // "description": "my_description",
* // "displayName": "my_displayName",
* // "escalated": false,
* // "name": "my_name",
* // "priority": "my_priority",
* // "severity": "my_severity",
* // "state": "my_state",
* // "subscriberEmailAddresses": [],
* // "testCase": false,
* // "timeZone": "my_timeZone",
* // "updateTime": "my_updateTime"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Cases$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Cases$Get, options?: MethodOptions): GaxiosPromise<Schema$Case>;
get(params: Params$Resource$Cases$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Cases$Get, options: MethodOptions | BodyResponseCallback<Schema$Case>, callback: BodyResponseCallback<Schema$Case>): void;
get(params: Params$Resource$Cases$Get, callback: BodyResponseCallback<Schema$Case>): void;
get(callback: BodyResponseCallback<Schema$Case>): void;
/**
* Retrieve all cases under the specified parent. Note: Listing cases under an Organization returns only the cases directly parented by that organization. To retrieve all cases under an organization, including cases parented by projects under that organization, use `cases.search`.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudsupport.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudsupport = google.cloudsupport('v2beta');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudsupport.cases.list({
* // An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases. Filter expressions use the following fields with the operators equals (`=`) and `AND`: - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - [DEPRECATED] `severity`: The accepted values are `S0`, `S1`, `S2`, `S3`, or `S4`. - `creator.email`: The email address of the case creator. Examples: - `state=CLOSED` - `state=OPEN AND creator.email="tester@example.com"` - `state=OPEN AND (priority=P0 OR priority=P1)`
* filter: 'placeholder-value',
* // The maximum number of cases fetched with each request. Defaults to 10.
* pageSize: 'placeholder-value',
* // A token identifying the page of results to return. If unspecified, the first page is retrieved.
* pageToken: 'placeholder-value',
* // Required. The fully qualified name of parent resource to list cases under.
* parent: '[^/]+/[^/]+',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "cases": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Cases$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Cases$List, options?: MethodOptions): GaxiosPromise<Schema$ListCasesResponse>;
list(params: Params$Resource$Cases$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Cases$List, options: MethodOptions | BodyResponseCallback<Schema$ListCasesResponse>, callback: BodyResponseCallback<Schema$ListCasesResponse>): void;
list(params: Params$Resource$Cases$List, callback: BodyResponseCallback<Schema$ListCasesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCasesResponse>): void;
/**
* Update the specified case. Only a subset of fields (display_name, description, time_zone, subscriber_email_addresses, related_resources, severity, priority, primary_contact, and labels) can be updated.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://