com.azure.analytics.synapse.artifacts.DatasetClient.yml

### YamlMime:JavaType
uid: "com.azure.analytics.synapse.artifacts.DatasetClient"
fullName: "com.azure.analytics.synapse.artifacts.DatasetClient"
name: "DatasetClient"
nameWithType: "DatasetClient"
summary: "Initializes a new instance of the synchronous Artifacts<wbr>Client type."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **DatasetClient**"
methods:
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.createOrUpdateDataset(java.lang.String,com.azure.analytics.synapse.artifacts.models.DatasetResource)"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.createOrUpdateDataset(String datasetName, DatasetResource dataset)"
  name: "createOrUpdateDataset(String datasetName, DatasetResource dataset)"
  nameWithType: "DatasetClient.createOrUpdateDataset(String datasetName, DatasetResource dataset)"
  summary: "Creates or updates a dataset."
  parameters:
  - description: "The dataset name."
    name: "datasetName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Dataset resource definition."
    name: "dataset"
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetResource?alt=com.azure.analytics.synapse.artifacts.models.DatasetResource&text=DatasetResource\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public DatasetResource createOrUpdateDataset(String datasetName, DatasetResource dataset)"
  desc: "Creates or updates a dataset."
  returns:
    description: "dataset resource type."
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetResource?alt=com.azure.analytics.synapse.artifacts.models.DatasetResource&text=DatasetResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.createOrUpdateDataset(java.lang.String,com.azure.analytics.synapse.artifacts.models.DatasetResource,java.lang.String)"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.createOrUpdateDataset(String datasetName, DatasetResource dataset, String ifMatch)"
  name: "createOrUpdateDataset(String datasetName, DatasetResource dataset, String ifMatch)"
  nameWithType: "DatasetClient.createOrUpdateDataset(String datasetName, DatasetResource dataset, String ifMatch)"
  summary: "Creates or updates a dataset."
  parameters:
  - description: "The dataset name."
    name: "datasetName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Dataset resource definition."
    name: "dataset"
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetResource?alt=com.azure.analytics.synapse.artifacts.models.DatasetResource&text=DatasetResource\" data-throw-if-not-resolved=\"False\" />"
  - description: "ETag of the dataset entity. Should only be specified for update, for which it should match\n     existing entity or can be * for unconditional update."
    name: "ifMatch"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public DatasetResource createOrUpdateDataset(String datasetName, DatasetResource dataset, String ifMatch)"
  desc: "Creates or updates a dataset."
  returns:
    description: "dataset resource type."
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetResource?alt=com.azure.analytics.synapse.artifacts.models.DatasetResource&text=DatasetResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.createOrUpdateDatasetWithResponse(java.lang.String,com.azure.analytics.synapse.artifacts.models.DatasetResource,java.lang.String,com.azure.core.util.Context)"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.createOrUpdateDatasetWithResponse(String datasetName, DatasetResource dataset, String ifMatch, Context context)"
  name: "createOrUpdateDatasetWithResponse(String datasetName, DatasetResource dataset, String ifMatch, Context context)"
  nameWithType: "DatasetClient.createOrUpdateDatasetWithResponse(String datasetName, DatasetResource dataset, String ifMatch, Context context)"
  summary: "Creates or updates a dataset."
  parameters:
  - description: "The dataset name."
    name: "datasetName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Dataset resource definition."
    name: "dataset"
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetResource?alt=com.azure.analytics.synapse.artifacts.models.DatasetResource&text=DatasetResource\" data-throw-if-not-resolved=\"False\" />"
  - description: "ETag of the dataset entity. Should only be specified for update, for which it should match\n     existing entity or can be * for unconditional update."
    name: "ifMatch"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The context to associate with this operation."
    name: "context"
    type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Response<DatasetResource> createOrUpdateDatasetWithResponse(String datasetName, DatasetResource dataset, String ifMatch, Context context)"
  desc: "Creates or updates a dataset."
  returns:
    description: "dataset resource type along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
    type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetResource?alt=com.azure.analytics.synapse.artifacts.models.DatasetResource&text=DatasetResource\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.deleteDataset(java.lang.String)"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.deleteDataset(String datasetName)"
  name: "deleteDataset(String datasetName)"
  nameWithType: "DatasetClient.deleteDataset(String datasetName)"
  summary: "Deletes a dataset."
  parameters:
  - description: "The dataset name."
    name: "datasetName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public void deleteDataset(String datasetName)"
  desc: "Deletes a dataset."
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.deleteDatasetWithResponse(java.lang.String,com.azure.core.util.Context)"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.deleteDatasetWithResponse(String datasetName, Context context)"
  name: "deleteDatasetWithResponse(String datasetName, Context context)"
  nameWithType: "DatasetClient.deleteDatasetWithResponse(String datasetName, Context context)"
  summary: "Deletes a dataset."
  parameters:
  - description: "The dataset name."
    name: "datasetName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The context to associate with this operation."
    name: "context"
    type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Response<Void> deleteDatasetWithResponse(String datasetName, Context context)"
  desc: "Deletes a dataset."
  returns:
    description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
    type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.getDataset(java.lang.String)"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.getDataset(String datasetName)"
  name: "getDataset(String datasetName)"
  nameWithType: "DatasetClient.getDataset(String datasetName)"
  summary: "Gets a dataset."
  parameters:
  - description: "The dataset name."
    name: "datasetName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public DatasetResource getDataset(String datasetName)"
  desc: "Gets a dataset."
  returns:
    description: "a dataset."
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetResource?alt=com.azure.analytics.synapse.artifacts.models.DatasetResource&text=DatasetResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.getDataset(java.lang.String,java.lang.String)"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.getDataset(String datasetName, String ifNoneMatch)"
  name: "getDataset(String datasetName, String ifNoneMatch)"
  nameWithType: "DatasetClient.getDataset(String datasetName, String ifNoneMatch)"
  summary: "Gets a dataset."
  parameters:
  - description: "The dataset name."
    name: "datasetName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing\n     entity tag, or if * was provided, then no content will be returned."
    name: "ifNoneMatch"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public DatasetResource getDataset(String datasetName, String ifNoneMatch)"
  desc: "Gets a dataset."
  returns:
    description: "a dataset."
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetResource?alt=com.azure.analytics.synapse.artifacts.models.DatasetResource&text=DatasetResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.getDatasetWithResponse(java.lang.String,java.lang.String,com.azure.core.util.Context)"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.getDatasetWithResponse(String datasetName, String ifNoneMatch, Context context)"
  name: "getDatasetWithResponse(String datasetName, String ifNoneMatch, Context context)"
  nameWithType: "DatasetClient.getDatasetWithResponse(String datasetName, String ifNoneMatch, Context context)"
  summary: "Gets a dataset."
  parameters:
  - description: "The dataset name."
    name: "datasetName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing\n     entity tag, or if * was provided, then no content will be returned."
    name: "ifNoneMatch"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The context to associate with this operation."
    name: "context"
    type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Response<DatasetResource> getDatasetWithResponse(String datasetName, String ifNoneMatch, Context context)"
  desc: "Gets a dataset."
  returns:
    description: "a dataset along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
    type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetResource?alt=com.azure.analytics.synapse.artifacts.models.DatasetResource&text=DatasetResource\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.getDatasetsByWorkspace()"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.getDatasetsByWorkspace()"
  name: "getDatasetsByWorkspace()"
  nameWithType: "DatasetClient.getDatasetsByWorkspace()"
  summary: "Lists datasets."
  syntax: "public PagedIterable<DatasetResource> getDatasetsByWorkspace()"
  desc: "Lists datasets."
  returns:
    description: "a list of dataset resources as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
    type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetResource?alt=com.azure.analytics.synapse.artifacts.models.DatasetResource&text=DatasetResource\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.getDatasetsByWorkspace(com.azure.core.util.Context)"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.getDatasetsByWorkspace(Context context)"
  name: "getDatasetsByWorkspace(Context context)"
  nameWithType: "DatasetClient.getDatasetsByWorkspace(Context context)"
  summary: "Lists datasets."
  parameters:
  - description: "The context to associate with this operation."
    name: "context"
    type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public PagedIterable<DatasetResource> getDatasetsByWorkspace(Context context)"
  desc: "Lists datasets."
  returns:
    description: "a list of dataset resources as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
    type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.analytics.synapse.artifacts.models.DatasetResource?alt=com.azure.analytics.synapse.artifacts.models.DatasetResource&text=DatasetResource\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.renameDataset(java.lang.String,com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest)"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.renameDataset(String datasetName, ArtifactRenameRequest request)"
  name: "renameDataset(String datasetName, ArtifactRenameRequest request)"
  nameWithType: "DatasetClient.renameDataset(String datasetName, ArtifactRenameRequest request)"
  summary: "Renames a dataset."
  parameters:
  - description: "The dataset name."
    name: "datasetName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "proposed new name."
    name: "request"
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest?alt=com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest&text=ArtifactRenameRequest\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public void renameDataset(String datasetName, ArtifactRenameRequest request)"
  desc: "Renames a dataset."
- uid: "com.azure.analytics.synapse.artifacts.DatasetClient.renameDatasetWithResponse(java.lang.String,com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest,com.azure.core.util.Context)"
  fullName: "com.azure.analytics.synapse.artifacts.DatasetClient.renameDatasetWithResponse(String datasetName, ArtifactRenameRequest request, Context context)"
  name: "renameDatasetWithResponse(String datasetName, ArtifactRenameRequest request, Context context)"
  nameWithType: "DatasetClient.renameDatasetWithResponse(String datasetName, ArtifactRenameRequest request, Context context)"
  summary: "Renames a dataset."
  parameters:
  - description: "The dataset name."
    name: "datasetName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "proposed new name."
    name: "request"
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest?alt=com.azure.analytics.synapse.artifacts.models.ArtifactRenameRequest&text=ArtifactRenameRequest\" data-throw-if-not-resolved=\"False\" />"
  - description: "The context to associate with this operation."
    name: "context"
    type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Response<Void> renameDatasetWithResponse(String datasetName, ArtifactRenameRequest request, Context context)"
  desc: "Renames a dataset."
  returns:
    description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
    type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
type: "class"
desc: "Initializes a new instance of the synchronous ArtifactsClient type."
metadata: {}
package: "com.azure.analytics.synapse.artifacts"
artifact: com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.15