Class ApiHubInstance.Config.Builder (0.28.0)

public static final class ApiHubInstance.Config.Builder extends GeneratedMessageV3.Builder<ApiHubInstance.Config.Builder> implements ApiHubInstance.ConfigOrBuilder

Available configurations to provision an ApiHub Instance.

Protobuf type google.cloud.apihub.v1.ApiHubInstance.Config

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ApiHubInstance.Config.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ApiHubInstance.Config.Builder
Overrides

build()

public ApiHubInstance.Config build()
Returns
Type Description
ApiHubInstance.Config

buildPartial()

public ApiHubInstance.Config buildPartial()
Returns
Type Description
ApiHubInstance.Config

clear()

public ApiHubInstance.Config.Builder clear()
Returns
Type Description
ApiHubInstance.Config.Builder
Overrides

clearCmekKeyName()

public ApiHubInstance.Config.Builder clearCmekKeyName()

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.

string cmek_key_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ApiHubInstance.Config.Builder

This builder for chaining.

clearDisableSearch()

public ApiHubInstance.Config.Builder clearDisableSearch()

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

bool disable_search = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ApiHubInstance.Config.Builder

This builder for chaining.

clearEncryptionType()

public ApiHubInstance.Config.Builder clearEncryptionType()

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.

.google.cloud.apihub.v1.ApiHubInstance.Config.EncryptionType encryption_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ApiHubInstance.Config.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ApiHubInstance.Config.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ApiHubInstance.Config.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ApiHubInstance.Config.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ApiHubInstance.Config.Builder
Overrides

clearVertexLocation()

public ApiHubInstance.Config.Builder clearVertexLocation()

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

string vertex_location = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ApiHubInstance.Config.Builder

This builder for chaining.

clone()

public ApiHubInstance.Config.Builder clone()
Returns
Type Description
ApiHubInstance.Config.Builder
Overrides

getCmekKeyName()

public String 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.

string cmek_key_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The cmekKeyName.

getCmekKeyNameBytes()

public ByteString getCmekKeyNameBytes()

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.

string cmek_key_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for cmekKeyName.

getDefaultInstanceForType()

public ApiHubInstance.Config getDefaultInstanceForType()
Returns
Type Description
ApiHubInstance.Config

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisableSearch()

public boolean getDisableSearch()

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

bool disable_search = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The disableSearch.

getEncryptionType()

public ApiHubInstance.Config.EncryptionType 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.

.google.cloud.apihub.v1.ApiHubInstance.Config.EncryptionType encryption_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ApiHubInstance.Config.EncryptionType

The encryptionType.

getEncryptionTypeValue()

public int getEncryptionTypeValue()

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.

.google.cloud.apihub.v1.ApiHubInstance.Config.EncryptionType encryption_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for encryptionType.

getVertexLocation()

public String getVertexLocation()

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

string vertex_location = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The vertexLocation.

getVertexLocationBytes()

public ByteString getVertexLocationBytes()

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

string vertex_location = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for vertexLocation.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ApiHubInstance.Config other)

public ApiHubInstance.Config.Builder mergeFrom(ApiHubInstance.Config other)
Parameter
Name Description
other ApiHubInstance.Config
Returns
Type Description
ApiHubInstance.Config.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ApiHubInstance.Config.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ApiHubInstance.Config.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ApiHubInstance.Config.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ApiHubInstance.Config.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ApiHubInstance.Config.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ApiHubInstance.Config.Builder
Overrides

setCmekKeyName(String value)

public ApiHubInstance.Config.Builder setCmekKeyName(String value)

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.

string cmek_key_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The cmekKeyName to set.

Returns
Type Description
ApiHubInstance.Config.Builder

This builder for chaining.

setCmekKeyNameBytes(ByteString value)

public ApiHubInstance.Config.Builder setCmekKeyNameBytes(ByteString value)

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.

string cmek_key_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for cmekKeyName to set.

Returns
Type Description
ApiHubInstance.Config.Builder

This builder for chaining.

setDisableSearch(boolean value)

public ApiHubInstance.Config.Builder setDisableSearch(boolean value)

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

bool disable_search = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The disableSearch to set.

Returns
Type Description
ApiHubInstance.Config.Builder

This builder for chaining.

setEncryptionType(ApiHubInstance.Config.EncryptionType value)

public ApiHubInstance.Config.Builder setEncryptionType(ApiHubInstance.Config.EncryptionType value)

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.

.google.cloud.apihub.v1.ApiHubInstance.Config.EncryptionType encryption_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ApiHubInstance.Config.EncryptionType

The encryptionType to set.

Returns
Type Description
ApiHubInstance.Config.Builder

This builder for chaining.

setEncryptionTypeValue(int value)

public ApiHubInstance.Config.Builder setEncryptionTypeValue(int value)

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.

.google.cloud.apihub.v1.ApiHubInstance.Config.EncryptionType encryption_type = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for encryptionType to set.

Returns
Type Description
ApiHubInstance.Config.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ApiHubInstance.Config.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ApiHubInstance.Config.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ApiHubInstance.Config.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ApiHubInstance.Config.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ApiHubInstance.Config.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ApiHubInstance.Config.Builder
Overrides

setVertexLocation(String value)

public ApiHubInstance.Config.Builder setVertexLocation(String value)

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

string vertex_location = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The vertexLocation to set.

Returns
Type Description
ApiHubInstance.Config.Builder

This builder for chaining.

setVertexLocationBytes(ByteString value)

public ApiHubInstance.Config.Builder setVertexLocationBytes(ByteString value)

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

string vertex_location = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for vertexLocation to set.

Returns
Type Description
ApiHubInstance.Config.Builder

This builder for chaining.