Class IdentityMappingStore (0.63.0)

public final class IdentityMappingStore extends GeneratedMessageV3 implements IdentityMappingStoreOrBuilder

Identity Mapping Store which contains Identity Mapping Entries.

Protobuf type google.cloud.discoveryengine.v1.IdentityMappingStore

Static Fields

CMEK_CONFIG_FIELD_NUMBER

public static final int CMEK_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IdentityMappingStore getDefaultInstance()
Returns
Type Description
IdentityMappingStore

getDescriptor()

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

newBuilder()

public static IdentityMappingStore.Builder newBuilder()
Returns
Type Description
IdentityMappingStore.Builder

newBuilder(IdentityMappingStore prototype)

public static IdentityMappingStore.Builder newBuilder(IdentityMappingStore prototype)
Parameter
Name Description
prototype IdentityMappingStore
Returns
Type Description
IdentityMappingStore.Builder

parseDelimitedFrom(InputStream input)

public static IdentityMappingStore parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IdentityMappingStore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static IdentityMappingStore parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IdentityMappingStore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IdentityMappingStore parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IdentityMappingStore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IdentityMappingStore parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IdentityMappingStore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static IdentityMappingStore parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IdentityMappingStore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static IdentityMappingStore parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IdentityMappingStore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IdentityMappingStore
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<IdentityMappingStore> parser()
Returns
Type Description
Parser<IdentityMappingStore>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCmekConfig()

public CmekConfig getCmekConfig()

Output only. CMEK-related information for the Identity Mapping Store.

.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CmekConfig

The cmekConfig.

getCmekConfigOrBuilder()

public CmekConfigOrBuilder getCmekConfigOrBuilder()

Output only. CMEK-related information for the Identity Mapping Store.

.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CmekConfigOrBuilder

getDefaultInstanceForType()

public IdentityMappingStore getDefaultInstanceForType()
Returns
Type Description
IdentityMappingStore

getKmsKeyName()

public String getKmsKeyName()

Input only. The KMS key to be used to protect this Identity Mapping Store at creation time.

Must be set for requests that need to comply with CMEK Org Policy protections.

If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.

string kms_key_name = 3 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
String

The kmsKeyName.

getKmsKeyNameBytes()

public ByteString getKmsKeyNameBytes()

Input only. The KMS key to be used to protect this Identity Mapping Store at creation time.

Must be set for requests that need to comply with CMEK Org Policy protections.

If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field.

string kms_key_name = 3 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
ByteString

The bytes for kmsKeyName.

getName()

public String getName()

Immutable. The full resource name of the identity mapping store. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The full resource name of the identity mapping store. Format: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<IdentityMappingStore> getParserForType()
Returns
Type Description
Parser<IdentityMappingStore>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCmekConfig()

public boolean hasCmekConfig()

Output only. CMEK-related information for the Identity Mapping Store.

.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the cmekConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public IdentityMappingStore.Builder newBuilderForType()
Returns
Type Description
IdentityMappingStore.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IdentityMappingStore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
IdentityMappingStore.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public IdentityMappingStore.Builder toBuilder()
Returns
Type Description
IdentityMappingStore.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException