REST Resource: projects.locations.apiHubInstances

Resource: ApiHubInstance

An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "stateMessage": string,
  "config": {
    object (Config)
  },
  "labels": {
    string: string,
    ...
  },
  "description": string
}
Fields
name

string

Identifier. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}.
createTime

string (Timestamp format)

Output only. Creation timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Last update timestamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. The current state of the ApiHub instance.
stateMessage

string

Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is FAILED.
config

object (Config)

Required. Config of the ApiHub instance.
labels

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
description

string

Optional. Description of the ApiHub instance.

State

State of the ApiHub Instance.

Enums
STATE_UNSPECIFIED The default value. This value is used if the state is omitted.
INACTIVE The ApiHub instance has not been initialized or has been deleted.
CREATING The ApiHub instance is being created.
ACTIVE The ApiHub instance has been created and is ready for use.
UPDATING The ApiHub instance is being updated.
DELETING The ApiHub instance is being deleted.
FAILED The ApiHub instance encountered an error during a state change.

Config

Available configurations to provision an ApiHub Instance.

JSON representation 
{
  "cmekKeyName": string,
  "disableSearch": boolean,
  "vertexLocation": string,
  "encryptionType": enum (EncryptionType)
}
Fields
cmekKeyName

string

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

string

Optional. The name of the Vertex AI location where the data store is stored.
encryptionType

enum (EncryptionType)

Optional. Encryption type for the region. If the encryption type is CMEK, the cmekKeyName must be provided. If no encryption type is provided, GMEK will be used.

EncryptionType

Types of data encryption.

Enums
ENCRYPTION_TYPE_UNSPECIFIED Encryption type unspecified.
GMEK Default encryption using Google managed encryption key.
CMEK Encryption using customer managed encryption key.

Methods

create

 Provisions instance resources for the API Hub.

get

 Gets details of a single API Hub instance.

lookup

 Looks up an Api Hub instance in a given GCP project.