Google Cloud Api Hub V1 Client - Class Config (0.4.1)

Reference documentation and code samples for the Google Cloud Api Hub V1 Client class Config.

Available configurations to provision an ApiHub Instance.

Generated from protobuf message google.cloud.apihub.v1.ApiHubInstance.Config

Namespace

Google \ Cloud \ ApiHub \ V1 \ ApiHubInstance

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ cmek_key_name 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.
↳ disable_search bool

Optional. If true, the search will be disabled for the instance. The default value is false.
↳ vertex_location string

Optional. The name of the Vertex AI location where the data store is stored.
↳ encryption_type int

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.

getCmekKeyName

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.

Returns
Type Description
string

setCmekKeyName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisableSearch

Optional. If true, the search will be disabled for the instance. The default value is false.

Returns
Type Description
bool

setDisableSearch

Optional. If true, the search will be disabled for the instance. The default value is false.

Parameter
Name Description
var bool
Returns
Type Description
$this

getVertexLocation

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

Returns
Type Description
string

setVertexLocation

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

Parameter
Name Description
var string
Returns
Type Description
$this

getEncryptionType

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.

Returns
Type Description
int Enum of type EncryptionType.

setEncryptionType

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.

Parameter
Name Description
var int

Enum of type EncryptionType.

Returns
Type Description
$this