WebApiVectorizerParameters Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.8.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.WebApiVectorizerParameters

Implements

JsonSerializable<WebApiVectorizerParameters>

public final class WebApiVectorizerParameters
implements JsonSerializable<WebApiVectorizerParameters>

Specifies the properties for connecting to a user-defined vectorizer.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static WebApiVectorizerParameters	fromJson(JsonReader jsonReader) Reads an instance of WebApiVectorizerParameters from the JsonReader.
SearchIndexerDataIdentity	getAuthIdentity() Get the authIdentity property: The user-assigned managed identity used for outbound connections.
String	getAuthResourceId() Get the authResourceId property: Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations.
Map<String,String>	getHttpHeaders() Get the httpHeaders property: The headers required to make the HTTP request.
String	getHttpMethod() Get the httpMethod property: The method for the HTTP request.
Duration	getTimeout() Get the timeout property: The desired timeout for the request.
String	getUrl() Get the url property: The URI of the Web API providing the vectorizer.
WebApiVectorizerParameters	setAuthIdentity(SearchIndexerDataIdentity authIdentity) Set the authIdentity property: The user-assigned managed identity used for outbound connections.
WebApiVectorizerParameters	setAuthResourceId(String authResourceId) Set the authResourceId property: Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations.
WebApiVectorizerParameters	setHttpHeaders(Map<String,String> httpHeaders) Set the httpHeaders property: The headers required to make the HTTP request.
WebApiVectorizerParameters	setHttpMethod(String httpMethod) Set the httpMethod property: The method for the HTTP request.
WebApiVectorizerParameters	setTimeout(Duration timeout) Set the timeout property: The desired timeout for the request.
WebApiVectorizerParameters	setUrl(String url) Set the url property: The URI of the Web API providing the vectorizer.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

WebApiVectorizerParameters

public WebApiVectorizerParameters()

Creates an instance of WebApiVectorizerParameters class.

Method Details

fromJson

public static WebApiVectorizerParameters fromJson(JsonReader jsonReader)

Reads an instance of WebApiVectorizerParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of WebApiVectorizerParameters 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 WebApiVectorizerParameters.

getAuthIdentity

public SearchIndexerDataIdentity getAuthIdentity()

Get the authIdentity property: The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.

Returns:

the authIdentity value.

getAuthResourceId

public String getAuthResourceId()

Get the authResourceId property: Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.

Returns:

the authResourceId value.

getHttpHeaders

public Map<String,String> getHttpHeaders()

Get the httpHeaders property: The headers required to make the HTTP request.

Returns:

the httpHeaders value.

getHttpMethod

public String getHttpMethod()

Get the httpMethod property: The method for the HTTP request.

Returns:

the httpMethod value.

getTimeout

public Duration getTimeout()

Get the timeout property: The desired timeout for the request. Default is 30 seconds.

Returns:

the timeout value.

getUrl

public String getUrl()

Get the url property: The URI of the Web API providing the vectorizer.

Returns:

the url value.

setAuthIdentity

public WebApiVectorizerParameters setAuthIdentity(SearchIndexerDataIdentity authIdentity)

Set the authIdentity property: The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared.

Parameters:

authIdentity - the authIdentity value to set.

Returns:

the WebApiVectorizerParameters object itself.

setAuthResourceId

public WebApiVectorizerParameters setAuthResourceId(String authResourceId)

Set the authResourceId property: Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.

Parameters:

authResourceId - the authResourceId value to set.

Returns:

the WebApiVectorizerParameters object itself.

setHttpHeaders

public WebApiVectorizerParameters setHttpHeaders(Map<String,String> httpHeaders)

Set the httpHeaders property: The headers required to make the HTTP request.

Parameters:

httpHeaders - the httpHeaders value to set.

Returns:

the WebApiVectorizerParameters object itself.

setHttpMethod

public WebApiVectorizerParameters setHttpMethod(String httpMethod)

Set the httpMethod property: The method for the HTTP request.

Parameters:

httpMethod - the httpMethod value to set.

Returns:

the WebApiVectorizerParameters object itself.

setTimeout

public WebApiVectorizerParameters setTimeout(Duration timeout)

Set the timeout property: The desired timeout for the request. Default is 30 seconds.

Parameters:

timeout - the timeout value to set.

Returns:

the WebApiVectorizerParameters object itself.

setUrl

public WebApiVectorizerParameters setUrl(String url)

Set the url property: The URI of the Web API providing the vectorizer.

Parameters:

url - the url value to set.

Returns:

the WebApiVectorizerParameters object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException