googleapis
Version:
Google APIs Client Library for Node.js
1,039 lines (1,038 loc) • 630 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace apihub_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
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;
}
/**
* API hub API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const apihub = google.apihub('v1');
* ```
*/
export class Apihub {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* 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 Schema$Empty {
}
/**
* The details for the action to execute.
*/
export interface Schema$GoogleCloudApihubV1ActionExecutionDetail {
/**
* Required. The action id of the plugin to execute.
*/
actionId?: string | null;
}
/**
* The additional spec content for the spec. This contains the metadata and the last update time for the additional spec content.
*/
export interface Schema$GoogleCloudApihubV1AdditionalSpecContent {
/**
* Output only. The time at which the spec content was created.
*/
createTime?: string | null;
/**
* Optional. The labels of the spec content e.g. specboost addon version.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Optional. The additional spec contents.
*/
specContents?: Schema$GoogleCloudApihubV1SpecContents;
/**
* Required. The type of the spec content.
*/
specContentType?: string | null;
/**
* Output only. The time at which the spec content was last updated.
*/
updateTime?: string | null;
}
/**
* Addon resource.
*/
export interface Schema$GoogleCloudApihubV1Addon {
/**
* Required. The configuration of the addon.
*/
config?: Schema$GoogleCloudApihubV1AddonConfig;
/**
* Output only. The time at which the addon was created.
*/
createTime?: string | null;
/**
* Required. The data source on which the addon operates. This determines which field in the `config` oneof is used.
*/
dataSource?: string | null;
/**
* Optional. The description of the addon.
*/
description?: string | null;
/**
* Required. The display name of the addon.
*/
displayName?: string | null;
/**
* Identifier. The name of the addon to enable. Format: `projects/{project\}/locations/{location\}/addons/{addon\}`.
*/
name?: string | null;
/**
* Output only. The state of the addon.
*/
state?: string | null;
/**
* Output only. The time at which the addon was last updated.
*/
updateTime?: string | null;
}
/**
* Configuration for the addon.
*/
export interface Schema$GoogleCloudApihubV1AddonConfig {
/**
* Configuration for addons which act on all data in the API hub.
*/
allDataAddonConfig?: Schema$GoogleCloudApihubV1AllDataAddonConfig;
/**
* Configuration for gateway plugin addons.
*/
gatewayPluginAddonConfig?: Schema$GoogleCloudApihubV1GatewayPluginAddonConfig;
}
/**
* Configuration for addons which act on all data in the API hub. This is used to specify if the addon is enabled for all data in the API hub.
*/
export interface Schema$GoogleCloudApihubV1AllDataAddonConfig {
/**
* Required. If true, the addon is enabled for all data in the API hub.
*/
enabled?: boolean | null;
}
/**
* The value that can be assigned to the attribute when the data type is enum.
*/
export interface Schema$GoogleCloudApihubV1AllowedValue {
/**
* Optional. The detailed description of the allowed value.
*/
description?: string | null;
/**
* Required. The display name of the allowed value.
*/
displayName?: string | null;
/**
* Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
*/
id?: string | null;
/**
* Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
*/
immutable?: boolean | null;
}
/**
* An API resource in the API Hub.
*/
export interface Schema$GoogleCloudApihubV1Api {
/**
* Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
*/
apiFunctionalRequirements?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
*/
apiRequirements?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Optional. The style of the API. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
*/
apiStyle?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
*/
apiTechnicalRequirements?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource.
*/
attributes?: {
[key: string]: Schema$GoogleCloudApihubV1AttributeValues;
} | null;
/**
* Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
*/
businessUnit?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Output only. The time at which the API resource was created.
*/
createTime?: string | null;
/**
* Optional. The description of the API resource.
*/
description?: string | null;
/**
* Required. The display name of the API resource.
*/
displayName?: string | null;
/**
* Optional. The documentation for the API resource.
*/
documentation?: Schema$GoogleCloudApihubV1Documentation;
/**
* Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource.
*/
fingerprint?: string | null;
/**
* Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
*/
maturityLevel?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Identifier. The name of the API resource in the API Hub. Format: `projects/{project\}/locations/{location\}/apis/{api\}`
*/
name?: string | null;
/**
* Optional. Owner details for the API resource.
*/
owner?: Schema$GoogleCloudApihubV1Owner;
/**
* Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}`
*/
selectedVersion?: string | null;
/**
* Output only. The list of sources and metadata from the sources of the API resource.
*/
sourceMetadata?: Schema$GoogleCloudApihubV1SourceMetadata[];
/**
* Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
*/
targetUser?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
*/
team?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Output only. The time at which the API resource was last updated.
*/
updateTime?: string | null;
/**
* Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}`
*/
versions?: string[] | null;
}
/**
* The API data to be collected.
*/
export interface Schema$GoogleCloudApihubV1ApiData {
/**
* Optional. The list of API metadata.
*/
apiMetadataList?: Schema$GoogleCloudApihubV1ApiMetadataList;
}
/**
* Configuration for Apigee Edge gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance.
*/
export interface Schema$GoogleCloudApihubV1ApigeeEdgeConfig {
/**
* Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
*/
environmentFilter?: Schema$GoogleCloudApihubV1EnvironmentFilter;
}
/**
* Configuration for Apigee OPDK gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance.
*/
export interface Schema$GoogleCloudApihubV1ApigeeOPDKConfig {
/**
* Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
*/
environmentFilter?: Schema$GoogleCloudApihubV1EnvironmentFilter;
}
/**
* Configuration for Apigee X and Apigee Hybrid gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance.
*/
export interface Schema$GoogleCloudApihubV1ApigeeXHybridConfig {
/**
* Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
*/
environmentFilter?: Schema$GoogleCloudApihubV1EnvironmentFilter;
}
/**
* An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.
*/
export interface Schema$GoogleCloudApihubV1ApiHubInstance {
/**
* Required. Config of the ApiHub instance.
*/
config?: Schema$GoogleCloudApihubV1Config;
/**
* Output only. Creation timestamp.
*/
createTime?: string | null;
/**
* Optional. Description of the ApiHub instance.
*/
description?: string | null;
/**
* Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
*/
labels?: {
[key: string]: string;
} | null;
/**
* Identifier. Format: `projects/{project\}/locations/{location\}/apiHubInstances/{apiHubInstance\}`.
*/
name?: string | null;
/**
* Output only. The current state of the ApiHub instance.
*/
state?: string | null;
/**
* Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is `FAILED`.
*/
stateMessage?: string | null;
/**
* Output only. Last update timestamp.
*/
updateTime?: string | null;
}
/**
* ApiHubResource is one of the resources such as Api, Operation, Deployment, Definition, Spec and Version resources stored in API-Hub.
*/
export interface Schema$GoogleCloudApihubV1ApiHubResource {
/**
* This represents Api resource in search results. Only name, display_name, description and owner fields are populated in search results.
*/
api?: Schema$GoogleCloudApihubV1Api;
/**
* This represents Definition resource in search results. Only name field is populated in search results.
*/
definition?: Schema$GoogleCloudApihubV1Definition;
/**
* This represents Deployment resource in search results. Only name, display_name, description, deployment_type and api_versions fields are populated in search results.
*/
deployment?: Schema$GoogleCloudApihubV1Deployment;
/**
* This represents ApiOperation resource in search results. Only name, description, spec and details fields are populated in search results.
*/
operation?: Schema$GoogleCloudApihubV1ApiOperation;
/**
* This represents Spec resource in search results. Only name, display_name, description, spec_type and documentation fields are populated in search results.
*/
spec?: Schema$GoogleCloudApihubV1Spec;
/**
* This represents Version resource in search results. Only name, display_name, description, lifecycle, compliance and accreditation fields are populated in search results.
*/
version?: Schema$GoogleCloudApihubV1Version;
}
/**
* Config for authentication with API key.
*/
export interface Schema$GoogleCloudApihubV1ApiKeyConfig {
/**
* Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project\}/secrets/{secrete\}/versions/{version\}`. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
*/
apiKey?: Schema$GoogleCloudApihubV1Secret;
/**
* Required. The location of the API key. The default value is QUERY.
*/
httpElementLocation?: string | null;
/**
* Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
*/
name?: string | null;
}
/**
* The API metadata.
*/
export interface Schema$GoogleCloudApihubV1APIMetadata {
/**
* Required. The API resource to be pushed to Hub's collect layer. The ID of the API resource will be generated by Hub to ensure uniqueness across all APIs across systems.
*/
api?: Schema$GoogleCloudApihubV1Api;
/**
* Optional. Timestamp indicating when the API was created at the source.
*/
originalCreateTime?: string | null;
/**
* Optional. The unique identifier of the API in the system where it was originally created.
*/
originalId?: string | null;
/**
* Required. Timestamp indicating when the API was last updated at the source.
*/
originalUpdateTime?: string | null;
/**
* Optional. The list of versions present in an API resource.
*/
versions?: Schema$GoogleCloudApihubV1VersionMetadata[];
}
/**
* The message to hold repeated API metadata.
*/
export interface Schema$GoogleCloudApihubV1ApiMetadataList {
/**
* Required. The list of API metadata.
*/
apiMetadata?: Schema$GoogleCloudApihubV1APIMetadata[];
}
/**
* Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.
*/
export interface Schema$GoogleCloudApihubV1ApiOperation {
/**
* Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource.
*/
attributes?: {
[key: string]: Schema$GoogleCloudApihubV1AttributeValues;
} | null;
/**
* Output only. The time at which the operation was created.
*/
createTime?: string | null;
/**
* Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
*/
details?: Schema$GoogleCloudApihubV1OperationDetails;
/**
* Identifier. The name of the operation. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/operations/{operation\}`
*/
name?: string | null;
/**
* Output only. The list of sources and metadata from the sources of the API operation.
*/
sourceMetadata?: Schema$GoogleCloudApihubV1SourceMetadata[];
/**
* Output only. The name of the spec will be of the format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.
*/
spec?: string | null;
/**
* Output only. The time at which the operation was last updated.
*/
updateTime?: string | null;
}
/**
* The view of an API.
*/
export interface Schema$GoogleCloudApihubV1ApiView {
/**
* Output only. MCP server view.
*/
mcpServerView?: Schema$GoogleCloudApihubV1FlattenedApiVersionDeploymentView;
/**
* Output only. MCP tools view.
*/
mcpToolView?: Schema$GoogleCloudApihubV1FlattenedApiVersionOperationDeploymentView;
}
/**
* The details of the Application Integration endpoint to be triggered for curation.
*/
export interface Schema$GoogleCloudApihubV1ApplicationIntegrationEndpointDetails {
/**
* Required. The API trigger ID of the Application Integration workflow.
*/
triggerId?: string | null;
/**
* Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/x/locations/x/integrations/x\}:execute` or `https://{location\}-integrations.googleapis.com/v1/{name=projects/x/locations/x/integrations/x\}:execute`
*/
uri?: string | null;
}
/**
* An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.
*/
export interface Schema$GoogleCloudApihubV1Attribute {
/**
* Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
*/
allowedValues?: Schema$GoogleCloudApihubV1AllowedValue[];
/**
* Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.
*/
cardinality?: number | null;
/**
* Output only. The time at which the attribute was created.
*/
createTime?: string | null;
/**
* Required. The type of the data of the attribute.
*/
dataType?: string | null;
/**
* Output only. The definition type of the attribute.
*/
definitionType?: string | null;
/**
* Optional. The description of the attribute.
*/
description?: string | null;
/**
* Required. The display name of the attribute.
*/
displayName?: string | null;
/**
* Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.
*/
mandatory?: boolean | null;
/**
* Identifier. The name of the attribute in the API Hub. Format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`
*/
name?: string | null;
/**
* Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.
*/
scope?: string | null;
/**
* Output only. The time at which the attribute was last updated.
*/
updateTime?: string | null;
}
/**
* The attribute values associated with resource.
*/
export interface Schema$GoogleCloudApihubV1AttributeValues {
/**
* Output only. The name of the attribute. Format: projects/{project\}/locations/{location\}/attributes/{attribute\}
*/
attribute?: string | null;
/**
* The attribute values associated with a resource in case attribute data type is enum.
*/
enumValues?: Schema$GoogleCloudApihubV1EnumAttributeValues;
/**
* The attribute values associated with a resource in case attribute data type is JSON.
*/
jsonValues?: Schema$GoogleCloudApihubV1StringAttributeValues;
/**
* The attribute values associated with a resource in case attribute data type is string.
*/
stringValues?: Schema$GoogleCloudApihubV1StringAttributeValues;
/**
* The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
*/
uriValues?: Schema$GoogleCloudApihubV1StringAttributeValues;
}
/**
* AuthConfig represents the authentication information.
*/
export interface Schema$GoogleCloudApihubV1AuthConfig {
/**
* Api Key Config.
*/
apiKeyConfig?: Schema$GoogleCloudApihubV1ApiKeyConfig;
/**
* Required. The authentication type.
*/
authType?: string | null;
/**
* Google Service Account.
*/
googleServiceAccountConfig?: Schema$GoogleCloudApihubV1GoogleServiceAccountConfig;
/**
* Oauth2.0 Client Credentials.
*/
oauth2ClientCredentialsConfig?: Schema$GoogleCloudApihubV1Oauth2ClientCredentialsConfig;
/**
* User Password.
*/
userPasswordConfig?: Schema$GoogleCloudApihubV1UserPasswordConfig;
}
/**
* AuthConfigTemplate represents the authentication template for a plugin.
*/
export interface Schema$GoogleCloudApihubV1AuthConfigTemplate {
/**
* Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.
*/
serviceAccount?: Schema$GoogleCloudApihubV1GoogleServiceAccountConfig;
/**
* Required. The list of authentication types supported by the plugin.
*/
supportedAuthTypes?: string[] | null;
}
/**
* The CollectApiData method's request.
*/
export interface Schema$GoogleCloudApihubV1CollectApiDataRequest {
/**
* Required. The action ID to be used for collecting the API data. This should map to one of the action IDs specified in action configs in the plugin.
*/
actionId?: string | null;
/**
* Required. The API data to be collected.
*/
apiData?: Schema$GoogleCloudApihubV1ApiData;
/**
* Required. The type of collection. Applies to all entries in api_data.
*/
collectionType?: string | null;
/**
* Required. The plugin instance collecting the API data. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}`.
*/
pluginInstance?: string | null;
}
/**
* Available configurations to provision an ApiHub Instance.
*/
export interface Schema$GoogleCloudApihubV1Config {
/**
* Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance.
*/
cmekKeyName?: string | null;
/**
* Optional. If true, the search will be disabled for the instance. The default value is false.
*/
disableSearch?: boolean | null;
/**
* Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used.
*/
encryptionType?: string | null;
/**
* Optional. The name of the Vertex AI location where the data store is stored.
*/
vertexLocation?: string | null;
}
/**
* ConfigTemplate represents the configuration template for a plugin.
*/
export interface Schema$GoogleCloudApihubV1ConfigTemplate {
/**
* Optional. The list of additional configuration variables for the plugin's configuration.
*/
additionalConfigTemplate?: Schema$GoogleCloudApihubV1ConfigVariableTemplate[];
/**
* Optional. The authentication template for the plugin.
*/
authConfigTemplate?: Schema$GoogleCloudApihubV1AuthConfigTemplate;
}
/**
* ConfigValueOption represents an option for a config variable of type enum or multi select.
*/
export interface Schema$GoogleCloudApihubV1ConfigValueOption {
/**
* Optional. Description of the option.
*/
description?: string | null;
/**
* Required. Display name of the option.
*/
displayName?: string | null;
/**
* Required. Id of the option.
*/
id?: string | null;
}
/**
* ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.
*/
export interface Schema$GoogleCloudApihubV1ConfigVariable {
/**
* Optional. The config variable value in case of config variable of type boolean.
*/
boolValue?: boolean | null;
/**
* Optional. The config variable value in case of config variable of type enum.
*/
enumValue?: Schema$GoogleCloudApihubV1ConfigValueOption;
/**
* Optional. The config variable value in case of config variable of type integer.
*/
intValue?: string | null;
/**
* Output only. Key will be the id to uniquely identify the config variable.
*/
key?: string | null;
/**
* Optional. The config variable value in case of config variable of type multi integer.
*/
multiIntValues?: Schema$GoogleCloudApihubV1MultiIntValues;
/**
* Optional. The config variable value in case of config variable of type multi select.
*/
multiSelectValues?: Schema$GoogleCloudApihubV1MultiSelectValues;
/**
* Optional. The config variable value in case of config variable of type multi string.
*/
multiStringValues?: Schema$GoogleCloudApihubV1MultiStringValues;
/**
* Optional. The config variable value in case of config variable of type secret.
*/
secretValue?: Schema$GoogleCloudApihubV1Secret;
/**
* Optional. The config variable value in case of config variable of type string.
*/
stringValue?: string | null;
}
/**
* ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.
*/
export interface Schema$GoogleCloudApihubV1ConfigVariableTemplate {
/**
* Optional. Description.
*/
description?: string | null;
/**
* Optional. Enum options. To be populated if `ValueType` is `ENUM`.
*/
enumOptions?: Schema$GoogleCloudApihubV1ConfigValueOption[];
/**
* Required. ID of the config variable. Must be unique within the configuration.
*/
id?: string | null;
/**
* Optional. Multi select options. To be populated if `ValueType` is `MULTI_SELECT`.
*/
multiSelectOptions?: Schema$GoogleCloudApihubV1ConfigValueOption[];
/**
* Optional. Flag represents that this `ConfigVariable` must be provided for a PluginInstance.
*/
required?: boolean | null;
/**
* Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
*/
validationRegex?: string | null;
/**
* Required. Type of the parameter: string, int, bool etc.
*/
valueType?: string | null;
}
/**
* A curation resource in the API Hub.
*/
export interface Schema$GoogleCloudApihubV1Curation {
/**
* Output only. The time at which the curation was created.
*/
createTime?: string | null;
/**
* Optional. The description of the curation.
*/
description?: string | null;
/**
* Required. The display name of the curation.
*/
displayName?: string | null;
/**
* Required. The endpoint to be triggered for curation.
*/
endpoint?: Schema$GoogleCloudApihubV1Endpoint;
/**
* Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed.
*/
lastExecutionErrorCode?: string | null;
/**
* Output only. Error message describing the failure, if any, during the last execution of the curation.
*/
lastExecutionErrorMessage?: string | null;
/**
* Output only. The last execution state of the curation.
*/
lastExecutionState?: string | null;
/**
* Identifier. The name of the curation. Format: `projects/{project\}/locations/{location\}/curations/{curation\}`
*/
name?: string | null;
/**
* Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance.
*/
pluginInstanceActions?: Schema$GoogleCloudApihubV1PluginInstanceActionID[];
/**
* Output only. The time at which the curation was last updated.
*/
updateTime?: string | null;
}
/**
* The curation information for this plugin instance.
*/
export interface Schema$GoogleCloudApihubV1CurationConfig {
/**
* Required. The curation type for this plugin instance.
*/
curationType?: string | null;
/**
* Optional. Custom curation information for this plugin instance.
*/
customCuration?: Schema$GoogleCloudApihubV1CustomCuration;
}
/**
* Custom curation information for this plugin instance.
*/
export interface Schema$GoogleCloudApihubV1CustomCuration {
/**
* Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project\}/locations/{location\}/curations/{curation\}`
*/
curation?: string | null;
}
/**
* Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only `schema` object is supported.
*/
export interface Schema$GoogleCloudApihubV1Definition {
/**
* Optional. The list of user defined attributes associated with the definition resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource.
*/
attributes?: {
[key: string]: Schema$GoogleCloudApihubV1AttributeValues;
} | null;
/**
* Output only. The time at which the definition was created.
*/
createTime?: string | null;
/**
* Identifier. The name of the definition. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/definitions/{definition\}`
*/
name?: string | null;
/**
* Output only. The value of a schema definition.
*/
schema?: Schema$GoogleCloudApihubV1Schema;
/**
* Output only. The name of the spec from where the definition was parsed. Format is `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}`
*/
spec?: string | null;
/**
* Output only. The type of the definition.
*/
type?: string | null;
/**
* Output only. The time at which the definition was last updated.
*/
updateTime?: string | null;
}
/**
* A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API.
*/
export interface Schema$GoogleCloudApihubV1Dependency {
/**
* Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource.
*/
attributes?: {
[key: string]: Schema$GoogleCloudApihubV1AttributeValues;
} | null;
/**
* Required. Immutable. The entity acting as the consumer in the dependency.
*/
consumer?: Schema$GoogleCloudApihubV1DependencyEntityReference;
/**
* Output only. The time at which the dependency was created.
*/
createTime?: string | null;
/**
* Optional. Human readable description corresponding of the dependency.
*/
description?: string | null;
/**
* Output only. Discovery mode of the dependency.
*/
discoveryMode?: string | null;
/**
* Output only. Error details of a dependency if the system has detected it internally.
*/
errorDetail?: Schema$GoogleCloudApihubV1DependencyErrorDetail;
/**
* Identifier. The name of the dependency in the API Hub. Format: `projects/{project\}/locations/{location\}/dependencies/{dependency\}`
*/
name?: string | null;
/**
* Output only. State of the dependency.
*/
state?: string | null;
/**
* Required. Immutable. The entity acting as the supplier in the dependency.
*/
supplier?: Schema$GoogleCloudApihubV1DependencyEntityReference;
/**
* Output only. The time at which the dependency was last updated.
*/
updateTime?: string | null;
}
/**
* Reference to an entity participating in a dependency.
*/
export interface Schema$GoogleCloudApihubV1DependencyEntityReference {
/**
* Output only. Display name of the entity.
*/
displayName?: string | null;
/**
* The resource name of an external API in the API Hub. Format: `projects/{project\}/locations/{location\}/externalApis/{external_api\}`
*/
externalApiResourceName?: string | null;
/**
* The resource name of an operation in the API Hub. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/operations/{operation\}`
*/
operationResourceName?: string | null;
}
/**
* Details describing error condition of a dependency.
*/
export interface Schema$GoogleCloudApihubV1DependencyErrorDetail {
/**
* Optional. Error in the dependency.
*/
error?: string | null;
/**
* Optional. Timestamp at which the error was found.
*/
errorTime?: string | null;
}
/**
* Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.
*/
export interface Schema$GoogleCloudApihubV1Deployment {
/**
* Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
*/
apiVersions?: string[] | null;
/**
* Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource.
*/
attributes?: {
[key: string]: Schema$GoogleCloudApihubV1AttributeValues;
} | null;
/**
* Output only. The time at which the deployment was created.
*/
createTime?: string | null;
/**
* Required. The type of deployment. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
*/
deploymentType?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Optional. The description of the deployment.
*/
description?: string | null;
/**
* Required. The display name of the deployment.
*/
displayName?: string | null;
/**
* Optional. The documentation of the deployment.
*/
documentation?: Schema$GoogleCloudApihubV1Documentation;
/**
* Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
*/
endpoints?: string[] | null;
/**
* Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
*/
environment?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL.
*/
managementUrl?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Identifier. The name of the deployment. Format: `projects/{project\}/locations/{location\}/deployments/{deployment\}`
*/
name?: string | null;
/**
* Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org\}/environments/{env\}/apis/{api\}. For ex: if a proxy with name `orders` is deployed in `staging` environment of `cymbal` organization, the resource URI would be: `organizations/cymbal/environments/staging/apis/orders`.
*/
resourceUri?: string | null;
/**
* Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
*/
slo?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.
*/
sourceEnvironment?: string | null;
/**
* Output only. The list of sources and metadata from the sources of the deployment.
*/
sourceMetadata?: Schema$GoogleCloudApihubV1SourceMetadata[];
/**
* Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.
*/
sourceProject?: string | null;
/**
* Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
*/
sourceUri?: Schema$GoogleCloudApihubV1AttributeValues;
/**
* Output only. The time at which the deployment was last updated.
*/
updateTime?: string | null;
}
/**
* The metadata associated with a deployment.
*/
export interface Schema$GoogleCloudApihubV1DeploymentMetadata {
/**
* Required. The deployment resource to be pushed to Hub's collect layer. The ID of the deployment will be generated by Hub.
*/
deployment?: Schema$GoogleCloudApihubV1Deployment;
/**
* Optional. Timestamp indicating when the deployment was created at the source.
*/
originalCreateTime?: string | null;
/**
* Optional. The unique identifier of the deployment in the system where it was originally created.
*/
originalId?: string | null;
/**
* Required. Timestamp indicating when the deployment was last updated at the source.
*/
originalUpdateTime?: string | null;
}
/**
* The DisablePluginInstanceAction method's request.
*/
export interface Schema$GoogleCloudApihubV1DisablePluginInstanceActionRequest {
/**