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 ( |
Fields | |
---|---|
name |
Identifier. Format: |
create |
Output only. Creation timestamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
update |
Output only. Last update timestamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
state |
Output only. The current state of the ApiHub instance. |
state |
Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is |
config |
Required. Config of the ApiHub instance. |
labels |
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 |
description |
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 ( |
Fields | |
---|---|
cmek |
Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of |
disable |
Optional. If true, the search will be disabled for the instance. The default value is false. |
vertex |
Optional. The name of the Vertex AI location where the data store is stored. |
encryption |
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 |
|
---|---|
|
Provisions instance resources for the API Hub. |
|
Gets details of a single API Hub instance. |
|
Looks up an Api Hub instance in a given GCP project. |