APIhub

import { APIhub } from "https://googleapis.deno.dev/v1/apihub:v1.ts";

class APIhub {

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

locations;

async projectsLocationsApiHubInstancesCreate(

parent: string,

req: GoogleCloudApihubV1ApiHubInstance,

opts?: ProjectsLocationsApiHubInstancesCreateOptions,

): Promise<GoogleLongrunningOperation>;

async projectsLocationsApiHubInstancesDelete(name: string): Promise<GoogleLongrunningOperation>;

async projectsLocationsApiHubInstancesGet(name: string): Promise<GoogleCloudApihubV1ApiHubInstance>;

async projectsLocationsApiHubInstancesLookup(parent: string): Promise<GoogleCloudApihubV1LookupApiHubInstanceResponse>;

async projectsLocationsApisCreate(

parent: string,

req: GoogleCloudApihubV1Api,

opts?: ProjectsLocationsApisCreateOptions,

): Promise<GoogleCloudApihubV1Api>;

async projectsLocationsApisDelete(name: string, opts?: ProjectsLocationsApisDeleteOptions): Promise<Empty>;

async projectsLocationsApisGet(name: string): Promise<GoogleCloudApihubV1Api>;

async projectsLocationsApisList(parent: string, opts?: ProjectsLocationsApisListOptions): Promise<GoogleCloudApihubV1ListApisResponse>;

async projectsLocationsApisPatch(

req: GoogleCloudApihubV1Api,

opts?: ProjectsLocationsApisPatchOptions,

): Promise<GoogleCloudApihubV1Api>;

async projectsLocationsApisVersionsCreate(

parent: string,

req: GoogleCloudApihubV1Version,

opts?: ProjectsLocationsApisVersionsCreateOptions,

): Promise<GoogleCloudApihubV1Version>;

async projectsLocationsApisVersionsDefinitionsGet(name: string): Promise<GoogleCloudApihubV1Definition>;

async projectsLocationsApisVersionsDelete(name: string, opts?: ProjectsLocationsApisVersionsDeleteOptions): Promise<Empty>;

async projectsLocationsApisVersionsGet(name: string): Promise<GoogleCloudApihubV1Version>;

async projectsLocationsApisVersionsList(parent: string, opts?: ProjectsLocationsApisVersionsListOptions): Promise<GoogleCloudApihubV1ListVersionsResponse>;

async projectsLocationsApisVersionsOperationsCreate(

parent: string,

req: GoogleCloudApihubV1ApiOperation,

opts?: ProjectsLocationsApisVersionsOperationsCreateOptions,

): Promise<GoogleCloudApihubV1ApiOperation>;

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

async projectsLocationsApisVersionsOperationsGet(name: string): Promise<GoogleCloudApihubV1ApiOperation>;

async projectsLocationsApisVersionsOperationsList(parent: string, opts?: ProjectsLocationsApisVersionsOperationsListOptions): Promise<GoogleCloudApihubV1ListApiOperationsResponse>;

async projectsLocationsApisVersionsOperationsPatch(

req: GoogleCloudApihubV1ApiOperation,

opts?: ProjectsLocationsApisVersionsOperationsPatchOptions,

): Promise<GoogleCloudApihubV1ApiOperation>;

async projectsLocationsApisVersionsPatch(

req: GoogleCloudApihubV1Version,

opts?: ProjectsLocationsApisVersionsPatchOptions,

): Promise<GoogleCloudApihubV1Version>;

async projectsLocationsApisVersionsSpecsCreate(

parent: string,

req: GoogleCloudApihubV1Spec,

opts?: ProjectsLocationsApisVersionsSpecsCreateOptions,

): Promise<GoogleCloudApihubV1Spec>;

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

async projectsLocationsApisVersionsSpecsGet(name: string): Promise<GoogleCloudApihubV1Spec>;

async projectsLocationsApisVersionsSpecsGetContents(name: string): Promise<GoogleCloudApihubV1SpecContents>;

async projectsLocationsApisVersionsSpecsLint(name: string, req: GoogleCloudApihubV1LintSpecRequest): Promise<Empty>;

async projectsLocationsApisVersionsSpecsList(parent: string, opts?: ProjectsLocationsApisVersionsSpecsListOptions): Promise<GoogleCloudApihubV1ListSpecsResponse>;

async projectsLocationsApisVersionsSpecsPatch(

req: GoogleCloudApihubV1Spec,

opts?: ProjectsLocationsApisVersionsSpecsPatchOptions,

): Promise<GoogleCloudApihubV1Spec>;

async projectsLocationsAttributesCreate(

parent: string,

req: GoogleCloudApihubV1Attribute,

opts?: ProjectsLocationsAttributesCreateOptions,

): Promise<GoogleCloudApihubV1Attribute>;

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

async projectsLocationsAttributesGet(name: string): Promise<GoogleCloudApihubV1Attribute>;

async projectsLocationsAttributesList(parent: string, opts?: ProjectsLocationsAttributesListOptions): Promise<GoogleCloudApihubV1ListAttributesResponse>;

async projectsLocationsAttributesPatch(

req: GoogleCloudApihubV1Attribute,

opts?: ProjectsLocationsAttributesPatchOptions,

): Promise<GoogleCloudApihubV1Attribute>;

async projectsLocationsCollectApiData(location: string, req: GoogleCloudApihubV1CollectApiDataRequest): Promise<GoogleLongrunningOperation>;

async projectsLocationsCurationsCreate(

parent: string,

req: GoogleCloudApihubV1Curation,

opts?: ProjectsLocationsCurationsCreateOptions,

): Promise<GoogleCloudApihubV1Curation>;

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

async projectsLocationsCurationsGet(name: string): Promise<GoogleCloudApihubV1Curation>;

async projectsLocationsCurationsList(parent: string, opts?: ProjectsLocationsCurationsListOptions): Promise<GoogleCloudApihubV1ListCurationsResponse>;

async projectsLocationsCurationsPatch(

req: GoogleCloudApihubV1Curation,

opts?: ProjectsLocationsCurationsPatchOptions,

): Promise<GoogleCloudApihubV1Curation>;

async projectsLocationsDependenciesCreate(

parent: string,

req: GoogleCloudApihubV1Dependency,

opts?: ProjectsLocationsDependenciesCreateOptions,

): Promise<GoogleCloudApihubV1Dependency>;

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

async projectsLocationsDependenciesGet(name: string): Promise<GoogleCloudApihubV1Dependency>;

async projectsLocationsDependenciesList(parent: string, opts?: ProjectsLocationsDependenciesListOptions): Promise<GoogleCloudApihubV1ListDependenciesResponse>;

async projectsLocationsDependenciesPatch(

req: GoogleCloudApihubV1Dependency,

opts?: ProjectsLocationsDependenciesPatchOptions,

): Promise<GoogleCloudApihubV1Dependency>;

async projectsLocationsDeploymentsCreate(

parent: string,

req: GoogleCloudApihubV1Deployment,

opts?: ProjectsLocationsDeploymentsCreateOptions,

): Promise<GoogleCloudApihubV1Deployment>;

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

async projectsLocationsDeploymentsGet(name: string): Promise<GoogleCloudApihubV1Deployment>;

async projectsLocationsDeploymentsList(parent: string, opts?: ProjectsLocationsDeploymentsListOptions): Promise<GoogleCloudApihubV1ListDeploymentsResponse>;

async projectsLocationsDeploymentsPatch(

req: GoogleCloudApihubV1Deployment,

opts?: ProjectsLocationsDeploymentsPatchOptions,

): Promise<GoogleCloudApihubV1Deployment>;

async projectsLocationsExternalApisCreate(

parent: string,

req: GoogleCloudApihubV1ExternalApi,

opts?: ProjectsLocationsExternalApisCreateOptions,

): Promise<GoogleCloudApihubV1ExternalApi>;

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

async projectsLocationsExternalApisGet(name: string): Promise<GoogleCloudApihubV1ExternalApi>;

async projectsLocationsExternalApisList(parent: string, opts?: ProjectsLocationsExternalApisListOptions): Promise<GoogleCloudApihubV1ListExternalApisResponse>;

async projectsLocationsExternalApisPatch(

req: GoogleCloudApihubV1ExternalApi,

opts?: ProjectsLocationsExternalApisPatchOptions,

): Promise<GoogleCloudApihubV1ExternalApi>;

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

async projectsLocationsHostProjectRegistrationsCreate(

parent: string,

req: GoogleCloudApihubV1HostProjectRegistration,

opts?: ProjectsLocationsHostProjectRegistrationsCreateOptions,

): Promise<GoogleCloudApihubV1HostProjectRegistration>;

async projectsLocationsHostProjectRegistrationsGet(name: string): Promise<GoogleCloudApihubV1HostProjectRegistration>;

async projectsLocationsHostProjectRegistrationsList(parent: string, opts?: ProjectsLocationsHostProjectRegistrationsListOptions): Promise<GoogleCloudApihubV1ListHostProjectRegistrationsResponse>;

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

async projectsLocationsLookupRuntimeProjectAttachment(name: string): Promise<GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse>;

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

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

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

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

async projectsLocationsPluginsCreate(

parent: string,

req: GoogleCloudApihubV1Plugin,

opts?: ProjectsLocationsPluginsCreateOptions,

): Promise<GoogleCloudApihubV1Plugin>;

async projectsLocationsPluginsDelete(name: string): Promise<GoogleLongrunningOperation>;

async projectsLocationsPluginsDisable(name: string, req: GoogleCloudApihubV1DisablePluginRequest): Promise<GoogleCloudApihubV1Plugin>;

async projectsLocationsPluginsEnable(name: string, req: GoogleCloudApihubV1EnablePluginRequest): Promise<GoogleCloudApihubV1Plugin>;

async projectsLocationsPluginsGet(name: string): Promise<GoogleCloudApihubV1Plugin>;

async projectsLocationsPluginsGetStyleGuide(name: string): Promise<GoogleCloudApihubV1StyleGuide>;

async projectsLocationsPluginsInstancesCreate(

parent: string,

req: GoogleCloudApihubV1PluginInstance,

opts?: ProjectsLocationsPluginsInstancesCreateOptions,

): Promise<GoogleLongrunningOperation>;

async projectsLocationsPluginsInstancesDelete(name: string): Promise<GoogleLongrunningOperation>;

async projectsLocationsPluginsInstancesDisableAction(name: string, req: GoogleCloudApihubV1DisablePluginInstanceActionRequest): Promise<GoogleLongrunningOperation>;

async projectsLocationsPluginsInstancesEnableAction(name: string, req: GoogleCloudApihubV1EnablePluginInstanceActionRequest): Promise<GoogleLongrunningOperation>;

async projectsLocationsPluginsInstancesExecuteAction(name: string, req: GoogleCloudApihubV1ExecutePluginInstanceActionRequest): Promise<GoogleLongrunningOperation>;

async projectsLocationsPluginsInstancesGet(name: string): Promise<GoogleCloudApihubV1PluginInstance>;

async projectsLocationsPluginsInstancesList(parent: string, opts?: ProjectsLocationsPluginsInstancesListOptions): Promise<GoogleCloudApihubV1ListPluginInstancesResponse>;

async projectsLocationsPluginsList(parent: string, opts?: ProjectsLocationsPluginsListOptions): Promise<GoogleCloudApihubV1ListPluginsResponse>;

async projectsLocationsPluginsStyleGuideGetContents(name: string): Promise<GoogleCloudApihubV1StyleGuideContents>;

async projectsLocationsPluginsUpdateStyleGuide(

req: GoogleCloudApihubV1StyleGuide,

opts?: ProjectsLocationsPluginsUpdateStyleGuideOptions,

): Promise<GoogleCloudApihubV1StyleGuide>;

async projectsLocationsRuntimeProjectAttachmentsCreate(

parent: string,

req: GoogleCloudApihubV1RuntimeProjectAttachment,

opts?: ProjectsLocationsRuntimeProjectAttachmentsCreateOptions,

): Promise<GoogleCloudApihubV1RuntimeProjectAttachment>;

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

async projectsLocationsRuntimeProjectAttachmentsGet(name: string): Promise<GoogleCloudApihubV1RuntimeProjectAttachment>;

async projectsLocationsRuntimeProjectAttachmentsList(parent: string, opts?: ProjectsLocationsRuntimeProjectAttachmentsListOptions): Promise<GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse>;

async projectsLocationsSearchResources(location: string, req: GoogleCloudApihubV1SearchResourcesRequest): Promise<GoogleCloudApihubV1SearchResourcesResponse>;

}

§Constructors

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

[src]

§Properties

locations

[src]

Lists host project registrations.

§Methods

projectsLocationsApiHubInstancesCreate(parent: string, req: GoogleCloudApihubV1ApiHubInstance, opts?: ProjectsLocationsApiHubInstancesCreateOptions): Promise<GoogleLongrunningOperation>

[src]

Provisions instance resources for the API Hub.

@param parent

Required. The parent resource for the Api Hub instance resource. Format: projects/{project}/locations/{location}

projectsLocationsApiHubInstancesDelete(name: string): Promise<GoogleLongrunningOperation>

[src]

Deletes the API hub instance.

@param name

Required. The name of the Api Hub instance to delete. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}.

projectsLocationsApiHubInstancesGet(name: string): Promise<GoogleCloudApihubV1ApiHubInstance>

[src]

Gets details of a single API Hub instance.

@param name

Required. The name of the Api Hub instance to retrieve. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}.

projectsLocationsApiHubInstancesLookup(parent: string): Promise<GoogleCloudApihubV1LookupApiHubInstanceResponse>

[src]

Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.

@param parent

Required. There will always be only one Api Hub instance for a GCP project across all locations. The parent resource for the Api Hub instance resource. Format: projects/{project}/locations/{location}

projectsLocationsApisCreate(parent: string, req: GoogleCloudApihubV1Api, opts?: ProjectsLocationsApisCreateOptions): Promise<GoogleCloudApihubV1Api>

[src]

Create an API resource in the API hub. Once an API resource is created, versions can be added to it.

@param parent

Required. The parent resource for the API resource. Format: projects/{project}/locations/{location}

projectsLocationsApisDelete(name: string, opts?: ProjectsLocationsApisDeleteOptions): Promise<Empty>

[src]

Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.

@param name

Required. The name of the API resource to delete. Format: projects/{project}/locations/{location}/apis/{api}

projectsLocationsApisGet(name: string): Promise<GoogleCloudApihubV1Api>

[src]

Get API resource details including the API versions contained in it.

@param name

Required. The name of the API resource to retrieve. Format: projects/{project}/locations/{location}/apis/{api}

projectsLocationsApisList(parent: string, opts?: ProjectsLocationsApisListOptions): Promise<GoogleCloudApihubV1ListApisResponse>

[src]

List API resources in the API hub.

@param parent

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

projectsLocationsApisPatch(name: string, req: GoogleCloudApihubV1Api, opts?: ProjectsLocationsApisPatchOptions): Promise<GoogleCloudApihubV1Api>

[src]

Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.

@param name

Identifier. The name of the API resource in the API Hub. Format: projects/{project}/locations/{location}/apis/{api}

projectsLocationsApisVersionsCreate(parent: string, req: GoogleCloudApihubV1Version, opts?: ProjectsLocationsApisVersionsCreateOptions): Promise<GoogleCloudApihubV1Version>

[src]

Create an API version for an API resource in the API hub.

@param parent

Required. The parent resource for API version. Format: projects/{project}/locations/{location}/apis/{api}

projectsLocationsApisVersionsDefinitionsGet(name: string): Promise<GoogleCloudApihubV1Definition>

[src]

Get details about a definition in an API version.

@param name

Required. The name of the definition to retrieve. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}

projectsLocationsApisVersionsDelete(name: string, opts?: ProjectsLocationsApisVersionsDeleteOptions): Promise<Empty>

[src]

Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.

@param name

Required. The name of the version to delete. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

projectsLocationsApisVersionsGet(name: string): Promise<GoogleCloudApihubV1Version>

[src]

Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.

@param name

Required. The name of the API version to retrieve. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

projectsLocationsApisVersionsList(parent: string, opts?: ProjectsLocationsApisVersionsListOptions): Promise<GoogleCloudApihubV1ListVersionsResponse>

[src]

List API versions of an API resource in the API hub.

@param parent

Required. The parent which owns this collection of API versions i.e., the API resource Format: projects/{project}/locations/{location}/apis/{api}

projectsLocationsApisVersionsOperationsCreate(parent: string, req: GoogleCloudApihubV1ApiOperation, opts?: ProjectsLocationsApisVersionsOperationsCreateOptions): Promise<GoogleCloudApihubV1ApiOperation>

[src]

Create an apiOperation in an API version. An apiOperation can be created only if the version has no apiOperations which were created by parsing a spec.

@param parent

Required. The parent resource for the operation resource. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

projectsLocationsApisVersionsOperationsDelete(name: string): Promise<Empty>

[src]

Delete an operation in an API version and we can delete only the operations created via create API. If the operation was created by parsing the spec, then it can be deleted by editing or deleting the spec.

@param name

Required. The name of the operation resource to delete. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

projectsLocationsApisVersionsOperationsGet(name: string): Promise<GoogleCloudApihubV1ApiOperation>

[src]

Get details about a particular operation in API version.

@param name

Required. The name of the operation to retrieve. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

projectsLocationsApisVersionsOperationsList(parent: string, opts?: ProjectsLocationsApisVersionsOperationsListOptions): Promise<GoogleCloudApihubV1ListApiOperationsResponse>

[src]

List operations in an API version.

@param parent

Required. The parent which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

projectsLocationsApisVersionsOperationsPatch(name: string, req: GoogleCloudApihubV1ApiOperation, opts?: ProjectsLocationsApisVersionsOperationsPatchOptions): Promise<GoogleCloudApihubV1ApiOperation>

[src]

Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.

@param name

Identifier. The name of the operation. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

projectsLocationsApisVersionsPatch(name: string, req: GoogleCloudApihubV1Version, opts?: ProjectsLocationsApisVersionsPatchOptions): Promise<GoogleCloudApihubV1Version>

[src]

Update API version. The following fields in the version can be updated currently: * display_name * description * documentation * deployments * lifecycle * compliance * accreditation * attributes The update_mask should be used to specify the fields being updated.

@param name

Identifier. The name of the version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

projectsLocationsApisVersionsSpecsCreate(parent: string, req: GoogleCloudApihubV1Spec, opts?: ProjectsLocationsApisVersionsSpecsCreateOptions): Promise<GoogleCloudApihubV1Spec>

[src]

Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of contents or source_uri must be provided. If contents is provided, then spec_type must also be provided. On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the projects/{project}/locations/{location}/attributes/system-spec-type attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the GetSpec method. In order to access the raw contents for a particular spec, use the GetSpecContents method. In order to access the operations parsed from the spec, use the ListAPIOperations method.

@param parent

Required. The parent resource for Spec. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

projectsLocationsApisVersionsSpecsDelete(name: string): Promise<Empty>

[src]

Delete a spec. Deleting a spec will also delete the associated operations from the version.

@param name

Required. The name of the spec to delete. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

projectsLocationsApisVersionsSpecsGet(name: string): Promise<GoogleCloudApihubV1Spec>

[src]

Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use GetSpecContents method to retrieve the same.

@param name

Required. The name of the spec to retrieve. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

projectsLocationsApisVersionsSpecsGetContents(name: string): Promise<GoogleCloudApihubV1SpecContents>

[src]

Get spec contents.

@param name

Required. The name of the spec whose contents need to be retrieved. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

projectsLocationsApisVersionsSpecsLint(name: string, req: GoogleCloudApihubV1LintSpecRequest): Promise<Empty>

[src]

Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.

@param name

Required. The name of the spec to be linted. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

projectsLocationsApisVersionsSpecsList(parent: string, opts?: ProjectsLocationsApisVersionsSpecsListOptions): Promise<GoogleCloudApihubV1ListSpecsResponse>

[src]

List specs corresponding to a particular API resource.

@param parent

Required. The parent, which owns this collection of specs. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

projectsLocationsApisVersionsSpecsPatch(name: string, req: GoogleCloudApihubV1Spec, opts?: ProjectsLocationsApisVersionsSpecsPatchOptions): Promise<GoogleCloudApihubV1Spec>

[src]

Update spec. The following fields in the spec can be updated: * display_name * source_uri * lint_response * attributes * contents * spec_type In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The update_mask should be used to specify the fields being updated.

@param name

Identifier. The name of the spec. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

projectsLocationsAttributesCreate(parent: string, req: GoogleCloudApihubV1Attribute, opts?: ProjectsLocationsAttributesCreateOptions): Promise<GoogleCloudApihubV1Attribute>

[src]

Create a user defined attribute. Certain pre defined attributes are already created by the API hub. These attributes will have type as SYSTEM_DEFINED and can be listed via ListAttributes method. Allowed values for the same can be updated via UpdateAttribute method.

@param parent

Required. The parent resource for Attribute. Format: projects/{project}/locations/{location}

projectsLocationsAttributesDelete(name: string): Promise<Empty>

[src]

Delete an attribute. Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.

@param name

Required. The name of the attribute to delete. Format: projects/{project}/locations/{location}/attributes/{attribute}

projectsLocationsAttributesGet(name: string): Promise<GoogleCloudApihubV1Attribute>

[src]

Get details about the attribute.

@param name

Required. The name of the attribute to retrieve. Format: projects/{project}/locations/{location}/attributes/{attribute}

projectsLocationsAttributesList(parent: string, opts?: ProjectsLocationsAttributesListOptions): Promise<GoogleCloudApihubV1ListAttributesResponse>

[src]

List all attributes.

@param parent

Required. The parent resource for Attribute. Format: projects/{project}/locations/{location}

projectsLocationsAttributesPatch(name: string, req: GoogleCloudApihubV1Attribute, opts?: ProjectsLocationsAttributesPatchOptions): Promise<GoogleCloudApihubV1Attribute>

[src]

Update the attribute. The following fields in the Attribute resource can be updated: * display_name The display name can be updated for user defined attributes only. * description The description can be updated for user defined attributes only. * allowed_values To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted. * cardinality The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update. The update_mask should be used to specify the fields being updated.

@param name

Identifier. The name of the attribute in the API Hub. Format: projects/{project}/locations/{location}/attributes/{attribute}

projectsLocationsCollectApiData(location: string, req: GoogleCloudApihubV1CollectApiDataRequest): Promise<GoogleLongrunningOperation>

[src]

Collect API data from a source and push it to Hub's collect layer.

@param location

Required. The regional location of the API hub instance and its resources. Format: projects/{project}/locations/{location}

projectsLocationsCurationsCreate(parent: string, req: GoogleCloudApihubV1Curation, opts?: ProjectsLocationsCurationsCreateOptions): Promise<GoogleCloudApihubV1Curation>

[src]

Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.

@param parent

Required. The parent resource for the curation resource. Format: projects/{project}/locations/{location}

projectsLocationsCurationsDelete(name: string): Promise<Empty>

[src]

Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.

@param name

Required. The name of the curation resource to delete. Format: projects/{project}/locations/{location}/curations/{curation}

projectsLocationsCurationsGet(name: string): Promise<GoogleCloudApihubV1Curation>

[src]

Get curation resource details.

@param name

Required. The name of the curation resource to retrieve. Format: projects/{project}/locations/{location}/curations/{curation}

projectsLocationsCurationsList(parent: string, opts?: ProjectsLocationsCurationsListOptions): Promise<GoogleCloudApihubV1ListCurationsResponse>

[src]

List curation resources in the API hub.

@param parent

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

projectsLocationsCurationsPatch(name: string, req: GoogleCloudApihubV1Curation, opts?: ProjectsLocationsCurationsPatchOptions): Promise<GoogleCloudApihubV1Curation>

[src]

Update a curation resource in the API hub. The following fields in the curation can be updated: * display_name * description The update_mask should be used to specify the fields being updated.

@param name

Identifier. The name of the curation. Format: projects/{project}/locations/{location}/curations/{curation}

projectsLocationsDependenciesCreate(parent: string, req: GoogleCloudApihubV1Dependency, opts?: ProjectsLocationsDependenciesCreateOptions): Promise<GoogleCloudApihubV1Dependency>

[src]

Create a dependency between two entities in the API hub.

@param parent

Required. The parent resource for the dependency resource. Format: projects/{project}/locations/{location}

projectsLocationsDependenciesDelete(name: string): Promise<Empty>

[src]

Delete the dependency resource.

@param name

Required. The name of the dependency resource to delete. Format: projects/{project}/locations/{location}/dependencies/{dependency}

projectsLocationsDependenciesGet(name: string): Promise<GoogleCloudApihubV1Dependency>

[src]

Get details about a dependency resource in the API hub.

@param name

Required. The name of the dependency resource to retrieve. Format: projects/{project}/locations/{location}/dependencies/{dependency}

projectsLocationsDependenciesList(parent: string, opts?: ProjectsLocationsDependenciesListOptions): Promise<GoogleCloudApihubV1ListDependenciesResponse>

[src]

List dependencies based on the provided filter and pagination parameters.

@param parent

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

projectsLocationsDependenciesPatch(name: string, req: GoogleCloudApihubV1Dependency, opts?: ProjectsLocationsDependenciesPatchOptions): Promise<GoogleCloudApihubV1Dependency>

[src]

Update a dependency based on the update_mask provided in the request. The following fields in the dependency can be updated: * description

@param name

Identifier. The name of the dependency in the API Hub. Format: projects/{project}/locations/{location}/dependencies/{dependency}

projectsLocationsDeploymentsCreate(parent: string, req: GoogleCloudApihubV1Deployment, opts?: ProjectsLocationsDeploymentsCreateOptions): Promise<GoogleCloudApihubV1Deployment>

[src]

Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.

@param parent

Required. The parent resource for the deployment resource. Format: projects/{project}/locations/{location}

projectsLocationsDeploymentsDelete(name: string): Promise<Empty>

[src]

Delete a deployment resource in the API hub.

@param name

Required. The name of the deployment resource to delete. Format: projects/{project}/locations/{location}/deployments/{deployment}

projectsLocationsDeploymentsGet(name: string): Promise<GoogleCloudApihubV1Deployment>

[src]

Get details about a deployment and the API versions linked to it.

@param name

Required. The name of the deployment resource to retrieve. Format: projects/{project}/locations/{location}/deployments/{deployment}

projectsLocationsDeploymentsList(parent: string, opts?: ProjectsLocationsDeploymentsListOptions): Promise<GoogleCloudApihubV1ListDeploymentsResponse>

[src]

List deployment resources in the API hub.

@param parent

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

projectsLocationsDeploymentsPatch(name: string, req: GoogleCloudApihubV1Deployment, opts?: ProjectsLocationsDeploymentsPatchOptions): Promise<GoogleCloudApihubV1Deployment>

[src]

Update a deployment resource in the API hub. The following fields in the deployment resource can be updated: * display_name * description * documentation * deployment_type * resource_uri * endpoints * slo * environment * attributes The update_mask should be used to specify the fields being updated.

@param name

Identifier. The name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

projectsLocationsExternalApisCreate(parent: string, req: GoogleCloudApihubV1ExternalApi, opts?: ProjectsLocationsExternalApisCreateOptions): Promise<GoogleCloudApihubV1ExternalApi>

[src]

Create an External API resource in the API hub.

@param parent

Required. The parent resource for the External API resource. Format: projects/{project}/locations/{location}

projectsLocationsExternalApisDelete(name: string): Promise<Empty>

[src]

Delete an External API resource in the API hub.

@param name

Required. The name of the External API resource to delete. Format: projects/{project}/locations/{location}/externalApis/{externalApi}

projectsLocationsExternalApisGet(name: string): Promise<GoogleCloudApihubV1ExternalApi>

[src]

Get details about an External API resource in the API hub.

@param name

Required. The name of the External API resource to retrieve. Format: projects/{project}/locations/{location}/externalApis/{externalApi}

projectsLocationsExternalApisList(parent: string, opts?: ProjectsLocationsExternalApisListOptions): Promise<GoogleCloudApihubV1ListExternalApisResponse>

[src]

List External API resources in the API hub.

@param parent

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

projectsLocationsExternalApisPatch(name: string, req: GoogleCloudApihubV1ExternalApi, opts?: ProjectsLocationsExternalApisPatchOptions): Promise<GoogleCloudApihubV1ExternalApi>

[src]

Update an External API resource in the API hub. The following fields can be updated: * display_name * description * documentation * endpoints * paths The update_mask should be used to specify the fields being updated.

@param name

Identifier. Format: projects/{project}/locations/{location}/externalApi/{externalApi}.

projectsLocationsGet(name: string): Promise<GoogleCloudLocationLocation>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsHostProjectRegistrationsCreate(parent: string, req: GoogleCloudApihubV1HostProjectRegistration, opts?: ProjectsLocationsHostProjectRegistrationsCreateOptions): Promise<GoogleCloudApihubV1HostProjectRegistration>

[src]

Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.

@param parent

Required. The parent resource for the host project. Format: projects/{project}/locations/{location}

projectsLocationsHostProjectRegistrationsGet(name: string): Promise<GoogleCloudApihubV1HostProjectRegistration>

[src]

Get a host project registration.

@param name

Required. Host project registration resource name. projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration_id}

projectsLocationsHostProjectRegistrationsList(parent: string, opts?: ProjectsLocationsHostProjectRegistrationsListOptions): Promise<GoogleCloudApihubV1ListHostProjectRegistrationsResponse>

[src]

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

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsLookupRuntimeProjectAttachment(name: string): Promise<GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse>

[src]

Look up a runtime project attachment. This API can be called in the context of any project.

@param name

Required. Runtime project ID to look up runtime project attachment for. Lookup happens across all regions. Expected format: projects/{project}/locations/{location}.

projectsLocationsOperationsCancel(name: string, req: GoogleLongrunningCancelOperationRequest): 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<GoogleLongrunningOperation>

[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<GoogleLongrunningListOperationsResponse>

[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.

projectsLocationsPluginsCreate(parent: string, req: GoogleCloudApihubV1Plugin, opts?: ProjectsLocationsPluginsCreateOptions): Promise<GoogleCloudApihubV1Plugin>

[src]

Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.

@param parent

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

projectsLocationsPluginsDelete(name: string): Promise<GoogleLongrunningOperation>

[src]

Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.

@param name

Required. The name of the Plugin resource to delete. Format: projects/{project}/locations/{location}/plugins/{plugin}

projectsLocationsPluginsDisable(name: string, req: GoogleCloudApihubV1DisablePluginRequest): Promise<GoogleCloudApihubV1Plugin>

[src]

Disables a plugin. The state of the plugin after disabling is DISABLED

@param name

Required. The name of the plugin to disable. Format: projects/{project}/locations/{location}/plugins/{plugin}.

projectsLocationsPluginsEnable(name: string, req: GoogleCloudApihubV1EnablePluginRequest): Promise<GoogleCloudApihubV1Plugin>

[src]

Enables a plugin. The state of the plugin after enabling is ENABLED

@param name

Required. The name of the plugin to enable. Format: projects/{project}/locations/{location}/plugins/{plugin}.

projectsLocationsPluginsGet(name: string): Promise<GoogleCloudApihubV1Plugin>

[src]

Get an API Hub plugin.

@param name

Required. The name of the plugin to retrieve. Format: projects/{project}/locations/{location}/plugins/{plugin}.

projectsLocationsPluginsGetStyleGuide(name: string): Promise<GoogleCloudApihubV1StyleGuide>

[src]

Get the style guide being used for linting.

@param name

Required. The name of the spec to retrieve. Format: projects/{project}/locations/{location}/plugins/{plugin}/styleGuide.

projectsLocationsPluginsInstancesCreate(parent: string, req: GoogleCloudApihubV1PluginInstance, opts?: ProjectsLocationsPluginsInstancesCreateOptions): Promise<GoogleLongrunningOperation>

[src]

Creates a Plugin instance in the API hub.

@param parent

Required. The parent of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}

projectsLocationsPluginsInstancesDelete(name: string): Promise<GoogleLongrunningOperation>

[src]

Deletes a plugin instance in the API hub.

@param name

Required. The name of the plugin instance to delete. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}.

projectsLocationsPluginsInstancesDisableAction(name: string, req: GoogleCloudApihubV1DisablePluginInstanceActionRequest): Promise<GoogleLongrunningOperation>

[src]

Disables a plugin instance in the API hub.

@param name

Required. The name of the plugin instance to disable. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

projectsLocationsPluginsInstancesEnableAction(name: string, req: GoogleCloudApihubV1EnablePluginInstanceActionRequest): Promise<GoogleLongrunningOperation>

[src]

Enables a plugin instance in the API hub.

@param name

Required. The name of the plugin instance to enable. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

projectsLocationsPluginsInstancesExecuteAction(name: string, req: GoogleCloudApihubV1ExecutePluginInstanceActionRequest): Promise<GoogleLongrunningOperation>

[src]

Executes a plugin instance in the API hub.

@param name

Required. The name of the plugin instance to execute. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

projectsLocationsPluginsInstancesGet(name: string): Promise<GoogleCloudApihubV1PluginInstance>

[src]

Get an API Hub plugin instance.

@param name

Required. The name of the plugin instance to retrieve. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

projectsLocationsPluginsInstancesList(parent: string, opts?: ProjectsLocationsPluginsInstancesListOptions): Promise<GoogleCloudApihubV1ListPluginInstancesResponse>

[src]

List all the plugins in a given project and location. - can be used as wildcard value for {plugin_id}

@param parent

Required. The parent resource where this plugin will be created. Format: projects/{project}/locations/{location}/plugins/{plugin}. To list plugin instances for multiple plugins, use the - character instead of the plugin ID.

projectsLocationsPluginsList(parent: string, opts?: ProjectsLocationsPluginsListOptions): Promise<GoogleCloudApihubV1ListPluginsResponse>

[src]

List all the plugins in a given project and location.

@param parent

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

projectsLocationsPluginsStyleGuideGetContents(name: string): Promise<GoogleCloudApihubV1StyleGuideContents>

[src]

Get the contents of the style guide.

@param name

Required. The name of the StyleGuide whose contents need to be retrieved. There is exactly one style guide resource per project per location. The expected format is projects/{project}/locations/{location}/plugins/{plugin}/styleGuide.

projectsLocationsPluginsUpdateStyleGuide(name: string, req: GoogleCloudApihubV1StyleGuide, opts?: ProjectsLocationsPluginsUpdateStyleGuideOptions): Promise<GoogleCloudApihubV1StyleGuide>

[src]

Update the styleGuide to be used for liniting in by API hub.

@param name

Identifier. The name of the style guide. Format: projects/{project}/locations/{location}/plugins/{plugin}/styleGuide

projectsLocationsRuntimeProjectAttachmentsCreate(parent: string, req: GoogleCloudApihubV1RuntimeProjectAttachment, opts?: ProjectsLocationsRuntimeProjectAttachmentsCreateOptions): Promise<GoogleCloudApihubV1RuntimeProjectAttachment>

[src]

Attaches a runtime project to the host project.

@param parent

Required. The parent resource for the Runtime Project Attachment. Format: projects/{project}/locations/{location}

projectsLocationsRuntimeProjectAttachmentsDelete(name: string): Promise<Empty>

[src]

Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.

@param name

Required. The name of the Runtime Project Attachment to delete. Format: projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}

projectsLocationsRuntimeProjectAttachmentsGet(name: string): Promise<GoogleCloudApihubV1RuntimeProjectAttachment>

[src]

Gets a runtime project attachment.

@param name

Required. The name of the API resource to retrieve. Format: projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}

projectsLocationsRuntimeProjectAttachmentsList(parent: string, opts?: ProjectsLocationsRuntimeProjectAttachmentsListOptions): Promise<GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse>

[src]

List runtime projects attached to the host project.

@param parent

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

projectsLocationsSearchResources(location: string, req: GoogleCloudApihubV1SearchResourcesRequest): Promise<GoogleCloudApihubV1SearchResourcesResponse>

[src]

Search across API-Hub resources.

@param location

Required. The resource name of the location which will be of the type projects/{project_id}/locations/{location_id}. This field is used to identify the instance of API-Hub in which resources should be searched.