Package com.azure.resourcemanager.machinelearning.models

Class ApiKeyAuthWorkspaceConnectionProperties

java.lang.Object

com.azure.resourcemanager.machinelearning.models.WorkspaceConnectionPropertiesV2

com.azure.resourcemanager.machinelearning.models.ApiKeyAuthWorkspaceConnectionProperties

All Implemented Interfaces:

com.azure.json.JsonSerializable<WorkspaceConnectionPropertiesV2>

public final class ApiKeyAuthWorkspaceConnectionProperties
extends WorkspaceConnectionPropertiesV2

This connection type covers the generic ApiKey auth connection categories, for examples: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (as type discriminator) Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {ApiBase} CognitiveService: Category:= CognitiveService AuthType:= ApiKey (as type discriminator) Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= ServiceRegion={serviceRegion} CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type discriminator) Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey Target:= {Endpoint} Use Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields.

Constructor Summary

Constructors

Constructor	Description
ApiKeyAuthWorkspaceConnectionProperties()	Creates an instance of ApiKeyAuthWorkspaceConnectionProperties class.

Method Summary

Modifier and Type	Method	Description
ConnectionAuthType	authType()	Get the authType property: Authentication type of the connection target.
String	createdByWorkspaceArmId()	Get the createdByWorkspaceArmId property: The createdByWorkspaceArmId property.
WorkspaceConnectionApiKey	credentials()	Get the credentials property: Api key object for workspace connection credential.
static ApiKeyAuthWorkspaceConnectionProperties	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ApiKeyAuthWorkspaceConnectionProperties from the JsonReader.
ConnectionGroup	group()	Get the group property: Group based on connection category.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)
void	validate()	Validates the instance.
ApiKeyAuthWorkspaceConnectionProperties	withCategory(ConnectionCategory category)	Set the category property: Category of the connection.
ApiKeyAuthWorkspaceConnectionProperties	withCredentials(WorkspaceConnectionApiKey credentials)	Set the credentials property: Api key object for workspace connection credential.
ApiKeyAuthWorkspaceConnectionProperties	withExpiryTime(OffsetDateTime expiryTime)	Set the expiryTime property: The expiryTime property.
ApiKeyAuthWorkspaceConnectionProperties	withIsSharedToAll(Boolean isSharedToAll)	Set the isSharedToAll property: The isSharedToAll property.
ApiKeyAuthWorkspaceConnectionProperties	withMetadata(Map<String,String> metadata)	Set the metadata property: Store user metadata for this connection.
ApiKeyAuthWorkspaceConnectionProperties	withSharedUserList(List<String> sharedUserList)	Set the sharedUserList property: The sharedUserList property.
ApiKeyAuthWorkspaceConnectionProperties	withTarget(String target)	Set the target property: The target property.
ApiKeyAuthWorkspaceConnectionProperties	withValue(String value)	Set the value property: Value details of the workspace connection.
ApiKeyAuthWorkspaceConnectionProperties	withValueFormat(ValueFormat valueFormat)	Set the valueFormat property: format for the workspace connection value.

Methods inherited from class com.azure.resourcemanager.machinelearning.models.WorkspaceConnectionPropertiesV2

category, expiryTime, isSharedToAll, metadata, sharedUserList, target, value, valueFormat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

ApiKeyAuthWorkspaceConnectionProperties

public ApiKeyAuthWorkspaceConnectionProperties()

Creates an instance of ApiKeyAuthWorkspaceConnectionProperties class.

Method Details

authType

public ConnectionAuthType authType()

Get the authType property: Authentication type of the connection target.

Overrides:

authType in class WorkspaceConnectionPropertiesV2

Returns:

the authType value.

credentials

public WorkspaceConnectionApiKey credentials()

Get the credentials property: Api key object for workspace connection credential.

Returns:

the credentials value.

withCredentials

public ApiKeyAuthWorkspaceConnectionProperties withCredentials(WorkspaceConnectionApiKey credentials)

Set the credentials property: Api key object for workspace connection credential.

Parameters:

credentials - the credentials value to set.

Returns:

the ApiKeyAuthWorkspaceConnectionProperties object itself.

createdByWorkspaceArmId

public String createdByWorkspaceArmId()

Get the createdByWorkspaceArmId property: The createdByWorkspaceArmId property.

Overrides:

createdByWorkspaceArmId in class WorkspaceConnectionPropertiesV2

Returns:

the createdByWorkspaceArmId value.

group

public ConnectionGroup group()

Get the group property: Group based on connection category.

Overrides:

group in class WorkspaceConnectionPropertiesV2

Returns:

the group value.

withCategory

public ApiKeyAuthWorkspaceConnectionProperties withCategory(ConnectionCategory category)

Set the category property: Category of the connection.

Overrides:

withCategory in class WorkspaceConnectionPropertiesV2

Parameters:

category - the category value to set.

Returns:

the WorkspaceConnectionPropertiesV2 object itself.

withExpiryTime

public ApiKeyAuthWorkspaceConnectionProperties withExpiryTime(OffsetDateTime expiryTime)

Set the expiryTime property: The expiryTime property.

Overrides:

withExpiryTime in class WorkspaceConnectionPropertiesV2

Parameters:

expiryTime - the expiryTime value to set.

Returns:

the WorkspaceConnectionPropertiesV2 object itself.

withIsSharedToAll

public ApiKeyAuthWorkspaceConnectionProperties withIsSharedToAll(Boolean isSharedToAll)

Set the isSharedToAll property: The isSharedToAll property.

Overrides:

withIsSharedToAll in class WorkspaceConnectionPropertiesV2

Parameters:

isSharedToAll - the isSharedToAll value to set.

Returns:

the WorkspaceConnectionPropertiesV2 object itself.

withTarget

public ApiKeyAuthWorkspaceConnectionProperties withTarget(String target)

Set the target property: The target property.

Overrides:

withTarget in class WorkspaceConnectionPropertiesV2

Parameters:

target - the target value to set.

Returns:

the WorkspaceConnectionPropertiesV2 object itself.

withMetadata

public ApiKeyAuthWorkspaceConnectionProperties withMetadata(Map<String,String> metadata)

Set the metadata property: Store user metadata for this connection.

Overrides:

withMetadata in class WorkspaceConnectionPropertiesV2

Parameters:

metadata - the metadata value to set.

Returns:

the WorkspaceConnectionPropertiesV2 object itself.

withSharedUserList

public ApiKeyAuthWorkspaceConnectionProperties withSharedUserList(List<String> sharedUserList)

Set the sharedUserList property: The sharedUserList property.

Overrides:

withSharedUserList in class WorkspaceConnectionPropertiesV2

Parameters:

sharedUserList - the sharedUserList value to set.

Returns:

the WorkspaceConnectionPropertiesV2 object itself.

withValue

public ApiKeyAuthWorkspaceConnectionProperties withValue(String value)

Set the value property: Value details of the workspace connection.

Overrides:

withValue in class WorkspaceConnectionPropertiesV2

Parameters:

value - the value value to set.

Returns:

the WorkspaceConnectionPropertiesV2 object itself.

withValueFormat

public ApiKeyAuthWorkspaceConnectionProperties withValueFormat(ValueFormat valueFormat)

Set the valueFormat property: format for the workspace connection value.

Overrides:

withValueFormat in class WorkspaceConnectionPropertiesV2

Parameters:

valueFormat - the valueFormat value to set.

Returns:

the WorkspaceConnectionPropertiesV2 object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class WorkspaceConnectionPropertiesV2

Throws:

IllegalArgumentException - thrown if the instance is not valid.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<WorkspaceConnectionPropertiesV2>

Overrides:

toJson in class WorkspaceConnectionPropertiesV2

Throws:

IOException

fromJson

public static ApiKeyAuthWorkspaceConnectionProperties fromJson(com.azure.json.JsonReader jsonReader)
                                                        throws IOException

Reads an instance of ApiKeyAuthWorkspaceConnectionProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ApiKeyAuthWorkspaceConnectionProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException - If an error occurs while reading the ApiKeyAuthWorkspaceConnectionProperties.