// Copyright 2022 Luca Casonato. All rights reserved. MIT license. /** * Rapid Migration Assessment API Client for Deno * ============================================== * * The Rapid Migration Assessment service is our first-party migration assessment and planning tool. * * Docs: https://cloud.google.com/migration-center * Source: https://googleapis.deno.dev/v1/rapidmigrationassessment:v1.ts */ import { auth, CredentialsClient, GoogleAuth, request } from "/_/base@v1/mod.ts"; export { auth, GoogleAuth }; export type { CredentialsClient }; /** * The Rapid Migration Assessment service is our first-party migration * assessment and planning tool. */ export class RapidMigrationAssessment { #client: CredentialsClient | undefined; #baseUrl: string; constructor(client?: CredentialsClient, baseUrl: string = "https://rapidmigrationassessment.googleapis.com/") { this.#client = client; this.#baseUrl = baseUrl; } /** * Creates an Annotation * * @param parent Required. Name of the parent (project+location). */ async projectsLocationsAnnotationsCreate(parent: string, req: Annotation, opts: ProjectsLocationsAnnotationsCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/annotations`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Gets details of a single Annotation. * * @param name Required. Name of the resource. */ async projectsLocationsAnnotationsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as Annotation; } /** * Create a Collector to manage the on-prem appliance which collects * information about Customer assets. * * @param parent Required. Name of the parent (project+location). */ async projectsLocationsCollectorsCreate(parent: string, req: Collector, opts: ProjectsLocationsCollectorsCreateOptions = {}): Promise { req = serializeCollector(req); const url = new URL(`${this.#baseUrl}v1/${ parent }/collectors`); if (opts.collectorId !== undefined) { url.searchParams.append("collectorId", String(opts.collectorId)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Deletes a single Collector - changes state of collector to "Deleting". * Background jobs does final deletion thorugh producer api. * * @param name Required. Name of the resource. */ async projectsLocationsCollectorsDelete(name: string, opts: ProjectsLocationsCollectorsDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * Gets details of a single Collector. * * @param name Required. Name of the resource. */ async projectsLocationsCollectorsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeCollector(data); } /** * Lists Collectors in a given project and location. * * @param parent Required. Parent value for ListCollectorsRequest. */ async projectsLocationsCollectorsList(parent: string, opts: ProjectsLocationsCollectorsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/collectors`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeListCollectorsResponse(data); } /** * Updates the parameters of a single Collector. * * @param name name of resource. */ async projectsLocationsCollectorsPatch(name: string, req: Collector, opts: ProjectsLocationsCollectorsPatchOptions = {}): Promise { req = serializeCollector(req); opts = serializeProjectsLocationsCollectorsPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * Pauses the given collector. * * @param name Required. Name of the resource. */ async projectsLocationsCollectorsPause(name: string, req: PauseCollectorRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }:pause`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Registers the given collector. * * @param name Required. Name of the resource. */ async projectsLocationsCollectorsRegister(name: string, req: RegisterCollectorRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }:register`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Resumes the given collector. * * @param name Required. Name of the resource. */ async projectsLocationsCollectorsResume(name: string, req: ResumeCollectorRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }:resume`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Gets information about a location. * * @param name Resource name for the location. */ async projectsLocationsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as Location; } /** * Lists information about the supported locations for this service. * * @param name The resource that owns the locations collection, if applicable. */ async projectsLocationsList(name: string, opts: ProjectsLocationsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }/locations`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListLocationsResponse; } /** * Starts asynchronous cancellation on a long-running operation. The server * makes a best effort to cancel the operation, but success is not guaranteed. * If the server doesn't support this method, it returns * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or * other methods to check whether the cancellation succeeded or whether the * operation completed despite cancellation. On successful cancellation, the * operation is not deleted; instead, it becomes an operation with an * Operation.error value with a google.rpc.Status.code of `1`, corresponding * to `Code.CANCELLED`. * * @param name The name of the operation resource to be cancelled. */ async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }:cancel`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Empty; } /** * Deletes a long-running operation. This method indicates that the client is * no longer interested in the operation result. It does not cancel the * operation. If the server doesn't support this method, it returns * `google.rpc.Code.UNIMPLEMENTED`. * * @param name The name of the operation resource to be deleted. */ async projectsLocationsOperationsDelete(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Empty; } /** * Gets the latest state of a long-running operation. Clients can use this * method to poll the operation result at intervals as recommended by the API * service. * * @param name The name of the operation resource. */ async projectsLocationsOperationsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as Operation; } /** * Lists operations that match the specified filter in the request. If the * server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param name The name of the operation's parent resource. */ async projectsLocationsOperationsList(name: string, opts: ProjectsLocationsOperationsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }/operations`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListOperationsResponse; } } /** * Message describing an Annotation */ export interface Annotation { /** * Output only. Create time stamp. */ readonly createTime?: Date; /** * Labels as key value pairs. */ labels?: { [key: string]: string }; /** * name of resource. */ name?: string; /** * Type of an annotation. */ type?: | "TYPE_UNSPECIFIED" | "TYPE_LEGACY_EXPORT_CONSENT" | "TYPE_QWIKLAB"; /** * Output only. Update time stamp. */ readonly updateTime?: Date; } /** * The request message for Operations.CancelOperation. */ export interface CancelOperationRequest { } /** * Message describing Collector object. */ export interface Collector { /** * Output only. Store cloud storage bucket name (which is a guid) created * with this Collector. */ readonly bucket?: string; /** * Output only. Client version. */ readonly clientVersion?: string; /** * How many days to collect data. */ collectionDays?: number; /** * Output only. Create time stamp. */ readonly createTime?: Date; /** * User specified description of the Collector. */ description?: string; /** * User specified name of the Collector. */ displayName?: string; /** * Uri for EULA (End User License Agreement) from customer. */ eulaUri?: string; /** * User specified expected asset count. */ expectedAssetCount?: bigint; /** * Output only. Reference to MC Source Guest Os Scan. */ readonly guestOsScan?: GuestOsScan; /** * Labels as key value pairs. */ labels?: { [key: string]: string }; /** * name of resource. */ name?: string; /** * Service Account email used to ingest data to this Collector. */ serviceAccount?: string; /** * Output only. State of the Collector. */ readonly state?: | "STATE_UNSPECIFIED" | "STATE_INITIALIZING" | "STATE_READY_TO_USE" | "STATE_REGISTERED" | "STATE_ACTIVE" | "STATE_PAUSED" | "STATE_DELETING" | "STATE_DECOMMISSIONED" | "STATE_ERROR"; /** * Output only. Update time stamp. */ readonly updateTime?: Date; /** * Output only. Reference to MC Source vsphere_scan. */ readonly vsphereScan?: VSphereScan; } function serializeCollector(data: any): Collector { return { ...data, expectedAssetCount: data["expectedAssetCount"] !== undefined ? String(data["expectedAssetCount"]) : undefined, }; } function deserializeCollector(data: any): Collector { return { ...data, createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined, expectedAssetCount: data["expectedAssetCount"] !== undefined ? BigInt(data["expectedAssetCount"]) : undefined, updateTime: data["updateTime"] !== undefined ? new Date(data["updateTime"]) : undefined, }; } /** * A generic empty message that you can re-use to avoid defining duplicated * empty messages in your APIs. A typical example is to use it as the request or * the response type of an API method. For instance: service Foo { rpc * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } */ export interface Empty { } /** * Message describing a MC Source of type Guest OS Scan. */ export interface GuestOsScan { /** * reference to the corresponding Guest OS Scan in MC Source. */ coreSource?: string; } /** * Message for response to listing Collectors. */ export interface ListCollectorsResponse { /** * The list of Collectors. */ collectors?: Collector[]; /** * A token identifying a page of results the server should return. */ nextPageToken?: string; /** * Locations that could not be reached. */ unreachable?: string[]; } function serializeListCollectorsResponse(data: any): ListCollectorsResponse { return { ...data, collectors: data["collectors"] !== undefined ? data["collectors"].map((item: any) => (serializeCollector(item))) : undefined, }; } function deserializeListCollectorsResponse(data: any): ListCollectorsResponse { return { ...data, collectors: data["collectors"] !== undefined ? data["collectors"].map((item: any) => (deserializeCollector(item))) : undefined, }; } /** * The response message for Locations.ListLocations. */ export interface ListLocationsResponse { /** * A list of locations that matches the specified filter in the request. */ locations?: Location[]; /** * The standard List next-page token. */ nextPageToken?: string; } /** * The response message for Operations.ListOperations. */ export interface ListOperationsResponse { /** * The standard List next-page token. */ nextPageToken?: string; /** * A list of operations that matches the specified filter in the request. */ operations?: Operation[]; } /** * A resource that represents a Google Cloud location. */ export interface Location { /** * The friendly name for this location, typically a nearby city name. For * example, "Tokyo". */ displayName?: string; /** * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ labels?: { [key: string]: string }; /** * The canonical id for this location. For example: `"us-east1"`. */ locationId?: string; /** * Service-specific metadata. For example the available capacity at the given * location. */ metadata?: { [key: string]: any }; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` */ name?: string; } /** * This resource represents a long-running operation that is the result of a * network API call. */ export interface Operation { /** * If the value is `false`, it means the operation is still in progress. If * `true`, the operation is completed, and either `error` or `response` is * available. */ done?: boolean; /** * The error result of the operation in case of failure or cancellation. */ error?: Status; /** * Service-specific metadata associated with the operation. It typically * contains progress information and common metadata such as create time. Some * services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ metadata?: { [key: string]: any }; /** * The server-assigned name, which is only unique within the same service * that originally returns it. If you use the default HTTP mapping, the `name` * should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** * The normal, successful response of the operation. If the original method * returns no data on success, such as `Delete`, the response is * `google.protobuf.Empty`. If the original method is standard * `Get`/`Create`/`Update`, the response should be the resource. For other * methods, the response should have the type `XxxResponse`, where `Xxx` is * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: { [key: string]: any }; } /** * Represents the metadata of the long-running operation. */ export interface OperationMetadata { /** * Output only. API version used to start the operation. */ readonly apiVersion?: string; /** * Output only. The time the operation was created. */ readonly createTime?: Date; /** * Output only. The time the operation finished running. */ readonly endTime?: Date; /** * Output only. Identifies whether the user has requested cancellation of the * operation. Operations that have successfully been cancelled have * Operation.error value with a google.rpc.Status.code of 1, corresponding to * `Code.CANCELLED`. */ readonly requestedCancellation?: boolean; /** * Output only. Human-readable status of the operation, if any. */ readonly statusMessage?: string; /** * Output only. Server-defined resource path for the target of the operation. */ readonly target?: string; /** * Output only. Name of the verb executed by the operation. */ readonly verb?: string; } /** * Message for pausing a Collector. */ export interface PauseCollectorRequest { /** * Optional. An optional request ID to identify requests. Specify a unique * request ID so that if you must retry your request, the server will know to * ignore the request if it has already been completed. The server will * guarantee that for at least 60 minutes after the first request. For * example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request ID, * the server can check if original operation with the same request ID was * received, and if so, will ignore the second request. This prevents clients * from accidentally creating duplicate commitments. The request ID must be a * valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). */ requestId?: string; } /** * Additional options for * RapidMigrationAssessment#projectsLocationsAnnotationsCreate. */ export interface ProjectsLocationsAnnotationsCreateOptions { /** * Optional. An optional request ID to identify requests. */ requestId?: string; } /** * Additional options for * RapidMigrationAssessment#projectsLocationsCollectorsCreate. */ export interface ProjectsLocationsCollectorsCreateOptions { /** * Required. Id of the requesting object. */ collectorId?: string; /** * Optional. An optional request ID to identify requests. */ requestId?: string; } /** * Additional options for * RapidMigrationAssessment#projectsLocationsCollectorsDelete. */ export interface ProjectsLocationsCollectorsDeleteOptions { /** * Optional. An optional request ID to identify requests. Specify a unique * request ID so that if you must retry your request, the server will know to * ignore the request if it has already been completed. The server will * guarantee that for at least 60 minutes after the first request. For * example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request ID, * the server can check if original operation with the same request ID was * received, and if so, will ignore the second request. This prevents clients * from accidentally creating duplicate commitments. The request ID must be a * valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). */ requestId?: string; } /** * Additional options for * RapidMigrationAssessment#projectsLocationsCollectorsList. */ export interface ProjectsLocationsCollectorsListOptions { /** * Filtering results. */ filter?: string; /** * Hint for how to order the results. */ orderBy?: string; /** * Requested page size. Server may return fewer items than requested. If * unspecified, server will pick an appropriate default. */ pageSize?: number; /** * A token identifying a page of results the server should return. */ pageToken?: string; } /** * Additional options for * RapidMigrationAssessment#projectsLocationsCollectorsPatch. */ export interface ProjectsLocationsCollectorsPatchOptions { /** * Optional. An optional request ID to identify requests. Specify a unique * request ID so that if you must retry your request, the server will know to * ignore the request if it has already been completed. The server will * guarantee that for at least 60 minutes since the first request. For * example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request ID, * the server can check if original operation with the same request ID was * received, and if so, will ignore the second request. This prevents clients * from accidentally creating duplicate commitments. The request ID must be a * valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** * Required. Field mask is used to specify the fields to be overwritten in * the Collector resource by the update. The fields specified in the * update_mask are relative to the resource, not the full request. A field * will be overwritten if it is in the mask. If the user does not provide a * mask then all fields will be overwritten. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsCollectorsPatchOptions(data: any): ProjectsLocationsCollectorsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsCollectorsPatchOptions(data: any): ProjectsLocationsCollectorsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for RapidMigrationAssessment#projectsLocationsList. */ export interface ProjectsLocationsListOptions { /** * A filter to narrow down results to a preferred subset. The filtering * language accepts strings like `"displayName=tokyo"`, and is documented in * more detail in [AIP-160](https://google.aip.dev/160). */ filter?: string; /** * The maximum number of results to return. If not set, the service selects a * default. */ pageSize?: number; /** * A page token received from the `next_page_token` field in the response. * Send that page token to receive the subsequent page. */ pageToken?: string; } /** * Additional options for * RapidMigrationAssessment#projectsLocationsOperationsList. */ export interface ProjectsLocationsOperationsListOptions { /** * The standard list filter. */ filter?: string; /** * The standard list page size. */ pageSize?: number; /** * The standard list page token. */ pageToken?: string; } /** * Message for registering a Collector. */ export interface RegisterCollectorRequest { /** * Optional. An optional request ID to identify requests. Specify a unique * request ID so that if you must retry your request, the server will know to * ignore the request if it has already been completed. The server will * guarantee that for at least 60 minutes after the first request. For * example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request ID, * the server can check if original operation with the same request ID was * received, and if so, will ignore the second request. This prevents clients * from accidentally creating duplicate commitments. The request ID must be a * valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). */ requestId?: string; } /** * Message for resuming a Collector. */ export interface ResumeCollectorRequest { /** * Optional. An optional request ID to identify requests. Specify a unique * request ID so that if you must retry your request, the server will know to * ignore the request if it has already been completed. The server will * guarantee that for at least 60 minutes after the first request. For * example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request ID, * the server can check if original operation with the same request ID was * received, and if so, will ignore the second request. This prevents clients * from accidentally creating duplicate commitments. The request ID must be a * valid UUID with the exception that zero UUID is not supported * (00000000-0000-0000-0000-000000000000). */ requestId?: string; } /** * The `Status` type defines a logical error model that is suitable for * different programming environments, including REST APIs and RPC APIs. It is * used by [gRPC](https://github.com/grpc). Each `Status` message contains three * pieces of data: error code, error message, and error details. You can find * out more about this error model and how to work with it in the [API Design * Guide](https://cloud.google.com/apis/design/errors). */ export interface Status { /** * The status code, which should be an enum value of google.rpc.Code. */ code?: number; /** * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ details?: { [key: string]: any }[]; /** * A developer-facing error message, which should be in English. Any * user-facing error message should be localized and sent in the * google.rpc.Status.details field, or localized by the client. */ message?: string; } /** * Message describing a MC Source of type VSphere Scan. */ export interface VSphereScan { /** * reference to the corresponding VSphere Scan in MC Source. */ coreSource?: string; }