Package com.azure.analytics.synapse.artifacts.models

Class AzureSearchIndexDataset

java.lang.Object

com.azure.analytics.synapse.artifacts.models.Dataset

com.azure.analytics.synapse.artifacts.models.AzureSearchIndexDataset

public class AzureSearchIndexDataset
extends Dataset

The Azure Search Index.

Constructor Summary

Constructors

Constructor	Description
AzureSearchIndexDataset()

Method Summary

Modifier and Type	Method	Description
Object	getIndexName()	Get the indexName property: The name of the Azure Search Index.
AzureSearchIndexDataset	setAnnotations(List<Object> annotations)	Set the annotations property: List of tags that can be used for describing the Dataset.
AzureSearchIndexDataset	setDescription(String description)	Set the description property: Dataset description.
AzureSearchIndexDataset	setFolder(DatasetFolder folder)	Set the folder property: The folder that this Dataset is in.
AzureSearchIndexDataset	setIndexName(Object indexName)	Set the indexName property: The name of the Azure Search Index.
AzureSearchIndexDataset	setLinkedServiceName(LinkedServiceReference linkedServiceName)	Set the linkedServiceName property: Linked service reference.
AzureSearchIndexDataset	setParameters(Map<String,ParameterSpecification> parameters)	Set the parameters property: Parameters for dataset.
AzureSearchIndexDataset	setSchema(Object schema)	Set the schema property: Columns that define the physical type schema of the dataset.
AzureSearchIndexDataset	setStructure(Object structure)	Set the structure property: Columns that define the structure of the dataset.

Methods inherited from class com.azure.analytics.synapse.artifacts.models.Dataset

getAdditionalProperties, getAnnotations, getDescription, getFolder, getLinkedServiceName, getParameters, getSchema, getStructure, setAdditionalProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

AzureSearchIndexDataset

public AzureSearchIndexDataset()

Method Detail

getIndexName

public Object getIndexName()

Get the indexName property: The name of the Azure Search Index. Type: string (or Expression with resultType string).

Returns:

the indexName value.

setIndexName

public AzureSearchIndexDataset setIndexName(Object indexName)

Set the indexName property: The name of the Azure Search Index. Type: string (or Expression with resultType string).

Parameters:

indexName - the indexName value to set.

Returns:

the AzureSearchIndexDataset object itself.

setDescription

public AzureSearchIndexDataset setDescription(String description)

Set the description property: Dataset description.

Overrides:

setDescription in class Dataset

Parameters:

description - the description value to set.

Returns:

the Dataset object itself.

setStructure

public AzureSearchIndexDataset setStructure(Object structure)

Set the structure property: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Overrides:

setStructure in class Dataset

Parameters:

structure - the structure value to set.

Returns:

the Dataset object itself.

setSchema

public AzureSearchIndexDataset setSchema(Object schema)

Set the schema property: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

Overrides:

setSchema in class Dataset

Parameters:

schema - the schema value to set.

Returns:

the Dataset object itself.

setLinkedServiceName

public AzureSearchIndexDataset setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

setLinkedServiceName in class Dataset

Parameters:

linkedServiceName - the linkedServiceName value to set.

Returns:

the Dataset object itself.

setParameters

public AzureSearchIndexDataset setParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for dataset.

Overrides:

setParameters in class Dataset

Parameters:

parameters - the parameters value to set.

Returns:

the Dataset object itself.

setAnnotations

public AzureSearchIndexDataset setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the Dataset.

Overrides:

setAnnotations in class Dataset

Parameters:

annotations - the annotations value to set.

Returns:

the Dataset object itself.

setFolder

public AzureSearchIndexDataset setFolder(DatasetFolder folder)

Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Overrides:

setFolder in class Dataset

Parameters:

folder - the folder value to set.

Returns:

the Dataset object itself.