APIm

import { APIm } from "https://googleapis.deno.dev/v1/apim:v1alpha.ts";

Enables users to discover shadow APIs in existing Google Cloud infrastructure.

class APIm {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsListApiObservationTags(parent: string, opts?: ProjectsLocationsListApiObservationTagsOptions): Promise<ListApiObservationTagsResponse>;

async projectsLocationsObservationJobsApiObservationsApiOperationsGet(name: string): Promise<ApiOperation>;

async projectsLocationsObservationJobsApiObservationsApiOperationsList(parent: string, opts?: ProjectsLocationsObservationJobsApiObservationsApiOperationsListOptions): Promise<ListApiOperationsResponse>;

async projectsLocationsObservationJobsApiObservationsBatchEditTags(parent: string, req: BatchEditTagsApiObservationsRequest): Promise<BatchEditTagsApiObservationsResponse>;

async projectsLocationsObservationJobsApiObservationsGet(name: string): Promise<ApiObservation>;

async projectsLocationsObservationJobsApiObservationsList(parent: string, opts?: ProjectsLocationsObservationJobsApiObservationsListOptions): Promise<ListApiObservationsResponse>;

async projectsLocationsObservationJobsCreate(

parent: string,

req: ObservationJob,

opts?: ProjectsLocationsObservationJobsCreateOptions,

): Promise<Operation>;

async projectsLocationsObservationJobsDelete(name: string): Promise<Operation>;

async projectsLocationsObservationJobsDisable(name: string, req: DisableObservationJobRequest): Promise<Operation>;

async projectsLocationsObservationJobsEnable(name: string, req: EnableObservationJobRequest): Promise<Operation>;

async projectsLocationsObservationJobsGet(name: string): Promise<ObservationJob>;

async projectsLocationsObservationJobsList(parent: string, opts?: ProjectsLocationsObservationJobsListOptions): Promise<ListObservationJobsResponse>;

async projectsLocationsObservationSourcesCreate(

parent: string,

req: ObservationSource,

opts?: ProjectsLocationsObservationSourcesCreateOptions,

): Promise<Operation>;

async projectsLocationsObservationSourcesDelete(name: string): Promise<Operation>;

async projectsLocationsObservationSourcesGet(name: string): Promise<ObservationSource>;

async projectsLocationsObservationSourcesList(parent: string, opts?: ProjectsLocationsObservationSourcesListOptions): Promise<ListObservationSourcesResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

}

§Constructors

new APIm(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsListApiObservationTags(parent: string, opts?: ProjectsLocationsListApiObservationTagsOptions): Promise<ListApiObservationTagsResponse>

[src]

ListApiObservationTags lists all extant tags on any observation in the given project.

@param parent

Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location}

projectsLocationsObservationJobsApiObservationsApiOperationsGet(name: string): Promise<ApiOperation>

[src]

GetApiOperation retrieves a single ApiOperation by name.

@param name

Required. The name of the ApiOperation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}/apiOperation/{api_operation}

projectsLocationsObservationJobsApiObservationsApiOperationsList(parent: string, opts?: ProjectsLocationsObservationJobsApiObservationsApiOperationsListOptions): Promise<ListApiOperationsResponse>

[src]

ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.

@param parent

Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}

projectsLocationsObservationJobsApiObservationsBatchEditTags(parent: string, req: BatchEditTagsApiObservationsRequest): Promise<BatchEditTagsApiObservationsResponse>

[src]

BatchEditTagsApiObservations adds or removes Tags for ApiObservations.

@param parent

Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}

projectsLocationsObservationJobsApiObservationsGet(name: string): Promise<ApiObservation>

[src]

GetApiObservation retrieves a single ApiObservation by name.

@param name

Required. The name of the ApiObservation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}

projectsLocationsObservationJobsApiObservationsList(parent: string, opts?: ProjectsLocationsObservationJobsApiObservationsListOptions): Promise<ListApiObservationsResponse>

[src]

ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.

@param parent

Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}

projectsLocationsObservationJobsCreate(parent: string, req: ObservationJob, opts?: ProjectsLocationsObservationJobsCreateOptions): Promise<Operation>

[src]

CreateObservationJob creates a new ObservationJob but does not have any effecton its own. It is a configuration that can be used in an Observation Job to collect data about existing APIs.

@param parent

Required. The parent resource where this ObservationJob will be created. Format: projects/{project}/locations/{location}

projectsLocationsObservationJobsDelete(name: string): Promise<Operation>

[src]

DeleteObservationJob deletes an ObservationJob. This method will fail if the observation job is currently being used by any ObservationSource, even if not enabled.

@param name

Required. Name of the resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job}

projectsLocationsObservationJobsDisable(name: string, req: DisableObservationJobRequest): Promise<Operation>

[src]

Disables the given ObservationJob.

@param name

Required. The name of the ObservationJob to disable. Format: projects/{project}/locations/{location}/observationJobs/{job}

projectsLocationsObservationJobsEnable(name: string, req: EnableObservationJobRequest): Promise<Operation>

[src]

Enables the given ObservationJob.

@param name

Required. The name of the ObservationJob to enable. Format: projects/{project}/locations/{location}/observationJobs/{job}

projectsLocationsObservationJobsGet(name: string): Promise<ObservationJob>

[src]

GetObservationJob retrieves a single ObservationJob by name.

@param name

Required. The name of the ObservationJob to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{job}

projectsLocationsObservationJobsList(parent: string, opts?: ProjectsLocationsObservationJobsListOptions): Promise<ListObservationJobsResponse>

[src]

ListObservationJobs gets all ObservationJobs for a given project and location.

@param parent

Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location}

projectsLocationsObservationSourcesCreate(parent: string, req: ObservationSource, opts?: ProjectsLocationsObservationSourcesCreateOptions): Promise<Operation>

[src]

CreateObservationSource creates a new ObservationSource but does not affect any deployed infrastructure. It is a configuration that can be used in an Observation Job to collect data about APIs running in user's dataplane.

@param parent

Required. Value for parent.

projectsLocationsObservationSourcesDelete(name: string): Promise<Operation>

[src]

DeleteObservationSource deletes an observation source. This method will fail if the observation source is currently being used by any ObservationJob, even if not enabled.

@param name

Required. Name of the resource Format: projects/{project}/locations/{location}/observationSources/{source}

projectsLocationsObservationSourcesGet(name: string): Promise<ObservationSource>

[src]

GetObservationSource retrieves a single ObservationSource by name.

@param name

Required. The name of the ObservationSource to retrieve. Format: projects/{project}/locations/{location}/observationSources/{source}

projectsLocationsObservationSourcesList(parent: string, opts?: ProjectsLocationsObservationSourcesListOptions): Promise<ListObservationSourcesResponse>

[src]

ListObservationSources gets all ObservationSources for a given project and location.

@param parent

Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location}

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

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.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

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.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

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.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

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.