From 052e7caba55d13ce97d403f47848abbee24bdff8 Mon Sep 17 00:00:00 2001 From: VSC-Service-Account Date: Sat, 10 Dec 2022 05:17:15 +0000 Subject: [PATCH] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=336327&view=results --- ...lth.ResourceHealthManager.Configurable.yml | 144 ++++ ...r.resourcehealth.ResourceHealthManager.yml | 107 +++ ...alth.fluent.AvailabilityStatusesClient.yml | 170 +++++ ...ehealth.fluent.MicrosoftResourceHealth.yml | 97 +++ ...resourcehealth.fluent.OperationsClient.yml | 41 ++ ....fluent.models.AvailabilityStatusInner.yml | 164 +++++ ...fluent.models.OperationListResultInner.yml | 68 ++ ...cemanager.resourcehealth.fluent.models.yml | 12 + ....resourcemanager.resourcehealth.fluent.yml | 13 + ...ehealth.models.AvailabilityStateValues.yml | 117 ++++ ...sourcehealth.models.AvailabilityStatus.yml | 85 +++ ...th.models.AvailabilityStatusListResult.yml | 92 +++ ...th.models.AvailabilityStatusProperties.yml | 452 ++++++++++++ ...bilityStatusPropertiesRecentlyResolved.yml | 116 ++++ ...urcehealth.models.AvailabilityStatuses.yml | 170 +++++ ...anager.resourcehealth.models.Operation.yml | 92 +++ ...resourcehealth.models.OperationDisplay.yml | 140 ++++ ...ourcehealth.models.OperationListResult.yml | 37 + ...nager.resourcehealth.models.Operations.yml | 41 ++ ...rcehealth.models.ReasonChronicityTypes.yml | 93 +++ ...esourcehealth.models.RecommendedAction.yml | 116 ++++ ...rcehealth.models.ServiceImpactingEvent.yml | 164 +++++ ...erviceImpactingEventIncidentProperties.yml | 140 ++++ ...lth.models.ServiceImpactingEventStatus.yml | 68 ++ ....resourcemanager.resourcehealth.models.yml | 26 + ...m.azure.resourcemanager.resourcehealth.yml | 12 + docs-ref-autogen/toc.yml | 56 ++ docs-ref-mapping/reference-latest.yml | 13 + ...alydetector.AnomalyDetectorAsyncClient.yml | 641 +++++++++--------- ....anomalydetector.AnomalyDetectorClient.yml | 568 ++++++++-------- ...ydetector.AnomalyDetectorClientBuilder.yml | 135 ++-- ...detector.AnomalyDetectorServiceVersion.yml | 85 +++ ...re.ai.anomalydetector.models.AlignMode.yml | 2 +- ....ai.anomalydetector.models.AlignPolicy.yml | 70 +- ...ydetector.models.AnomalyDetectionModel.yml | 69 ++ ...lydetector.models.AnomalyDetectorError.yml | 83 --- ...ector.models.AnomalyDetectorErrorCodes.yml | 199 ------ ...r.models.AnomalyDetectorErrorException.yml | 92 --- ...ydetector.models.AnomalyInterpretation.yml | 70 +- ...ai.anomalydetector.models.AnomalyState.yml | 62 +- ...ai.anomalydetector.models.AnomalyValue.yml | 86 +-- ...ector.models.ChangePointDetectResponse.yml | 93 --- ...malydetector.models.CorrelationChanges.yml | 54 +- ...e.ai.anomalydetector.models.DataSchema.yml | 93 +++ ...lydetector.models.DetectAnomalyHeaders.yml | 59 -- ...ydetector.models.DetectAnomalyResponse.yml | 60 -- ...nomalydetector.models.DetectionRequest.yml | 107 --- ...anomalydetector.models.DetectionResult.yml | 107 --- ...detector.models.DetectionResultSummary.yml | 131 ---- ...anomalydetector.models.DetectionStatus.yml | 106 --- ...anomalydetector.models.DiagnosticsInfo.yml | 24 +- ...lydetector.models.EntireDetectResponse.yml | 227 ------- ...i.anomalydetector.models.ErrorResponse.yml | 53 +- ...detector.models.ErrorResponseException.yml | 92 --- ...ai.anomalydetector.models.FillNAMethod.yml | 138 ++-- ...e.ai.anomalydetector.models.ImputeMode.yml | 4 +- ...malydetector.models.LastDetectResponse.yml | 251 ------- ...lydetector.models.LastDetectionRequest.yml | 83 --- ...alydetector.models.LastDetectionResult.yml | 83 --- ....azure.ai.anomalydetector.models.Model.yml | 131 ---- ...re.ai.anomalydetector.models.ModelInfo.yml | 170 +++-- ...re.ai.anomalydetector.models.ModelList.yml | 131 ---- ...i.anomalydetector.models.ModelSnapshot.yml | 165 ----- ...e.ai.anomalydetector.models.ModelState.yml | 88 +-- ....ai.anomalydetector.models.ModelStatus.yml | 2 +- ...dels.MultivariateBatchDetectionOptions.yml | 90 +++ ...ultivariateBatchDetectionResultSummary.yml | 69 ++ ...odels.MultivariateBatchDetectionStatus.yml | 106 +++ ...tor.models.MultivariateDetectionResult.yml | 59 ++ ...odels.MultivariateLastDetectionOptions.yml | 64 ++ ...models.MultivariateLastDetectionResult.yml | 49 ++ ...anomalydetector.models.TimeGranularity.yml | 2 +- ...anomalydetector.models.TimeSeriesPoint.yml | 36 +- ...r.models.TrainMultivariateModelHeaders.yml | 59 -- ....models.TrainMultivariateModelResponse.yml | 60 -- ...UnivariateChangePointDetectionOptions.yml} | 151 ++--- ...s.UnivariateChangePointDetectionResult.yml | 59 ++ ...tor.models.UnivariateDetectionOptions.yml} | 190 +++--- ...models.UnivariateEntireDetectionResult.yml | 109 +++ ...r.models.UnivariateLastDetectionResult.yml | 119 ++++ ...i.anomalydetector.models.VariableState.yml | 130 ++-- ....anomalydetector.models.VariableValues.yml | 100 +-- .../com.azure.ai.anomalydetector.models.yml | 43 +- .../com.azure.ai.anomalydetector.yml | 8 +- preview/docs-ref-autogen/toc.yml | 98 ++- .../docs-ref-mapping/reference-preview.yml | 2 +- 86 files changed, 5113 insertions(+), 3950 deletions(-) create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.ResourceHealthManager.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.OperationsClient.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.Operation.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.OperationDisplay.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.OperationListResult.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.Operations.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.RecommendedAction.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.yml create mode 100644 docs-ref-autogen/com.azure.resourcemanager.resourcehealth.yml create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.yml create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectionModel.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorError.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ChangePointDetectResponse.yml create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DataSchema.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectAnomalyHeaders.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectAnomalyResponse.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionRequest.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionResult.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionResultSummary.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionStatus.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.EntireDetectResponse.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ErrorResponseException.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectResponse.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectionRequest.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectionResult.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.Model.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelList.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelSnapshot.yml create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.yml create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.yml create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateDetectionResult.yml create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions.yml create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders.yml delete mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TrainMultivariateModelResponse.yml rename preview/docs-ref-autogen/{com.azure.ai.anomalydetector.models.ChangePointDetectRequest.yml => com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.yml} (53%) create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult.yml rename preview/docs-ref-autogen/{com.azure.ai.anomalydetector.models.DetectRequest.yml => com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.yml} (57%) create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.yml create mode 100644 preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.yml diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.yml new file mode 100644 index 000000000000..5cb3d13e2f9d --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.yml @@ -0,0 +1,144 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable" +fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable" +name: "ResourceHealthManager.Configurable" +nameWithType: "ResourceHealthManager.Configurable" +summary: "The Configurable allowing configurations to be set." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public static final class **ResourceHealthManager.Configurable**" +methods: +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.authenticate(com.azure.core.credential.TokenCredential,com.azure.core.management.profile.AzureProfile)" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.authenticate(TokenCredential credential, AzureProfile profile)" + name: "authenticate(TokenCredential credential, AzureProfile profile)" + nameWithType: "ResourceHealthManager.Configurable.authenticate(TokenCredential credential, AzureProfile profile)" + summary: "Creates an instance of ResourceHealth service API entry point." + parameters: + - description: "the credential to use." + name: "credential" + type: "" + - description: "the Azure profile for client." + name: "profile" + type: "" + syntax: "public ResourceHealthManager authenticate(TokenCredential credential, AzureProfile profile)" + desc: "Creates an instance of ResourceHealth service API entry point." + returns: + description: "the ResourceHealth service API instance." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withDefaultPollInterval(java.time.Duration)" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withDefaultPollInterval(Duration defaultPollInterval)" + name: "withDefaultPollInterval(Duration defaultPollInterval)" + nameWithType: "ResourceHealthManager.Configurable.withDefaultPollInterval(Duration defaultPollInterval)" + summary: "Sets the default poll interval, used when service does not provide \"Retry-After\" header." + parameters: + - description: "the default poll interval." + name: "defaultPollInterval" + type: "Duration" + syntax: "public ResourceHealthManager.Configurable withDefaultPollInterval(Duration defaultPollInterval)" + desc: "Sets the default poll interval, used when service does not provide \"Retry-After\" header." + returns: + description: "the configurable object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withHttpClient(com.azure.core.http.HttpClient)" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withHttpClient(HttpClient httpClient)" + name: "withHttpClient(HttpClient httpClient)" + nameWithType: "ResourceHealthManager.Configurable.withHttpClient(HttpClient httpClient)" + summary: "Sets the http client." + parameters: + - description: "the HTTP client." + name: "httpClient" + type: "" + syntax: "public ResourceHealthManager.Configurable withHttpClient(HttpClient httpClient)" + desc: "Sets the http client." + returns: + description: "the configurable object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withLogOptions(com.azure.core.http.policy.HttpLogOptions)" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withLogOptions(HttpLogOptions httpLogOptions)" + name: "withLogOptions(HttpLogOptions httpLogOptions)" + nameWithType: "ResourceHealthManager.Configurable.withLogOptions(HttpLogOptions httpLogOptions)" + summary: "Sets the logging options to the HTTP pipeline." + parameters: + - description: "the HTTP log options." + name: "httpLogOptions" + type: "" + syntax: "public ResourceHealthManager.Configurable withLogOptions(HttpLogOptions httpLogOptions)" + desc: "Sets the logging options to the HTTP pipeline." + returns: + description: "the configurable object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withPolicy(com.azure.core.http.policy.HttpPipelinePolicy)" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withPolicy(HttpPipelinePolicy policy)" + name: "withPolicy(HttpPipelinePolicy policy)" + nameWithType: "ResourceHealthManager.Configurable.withPolicy(HttpPipelinePolicy policy)" + summary: "Adds the pipeline policy to the HTTP pipeline." + parameters: + - description: "the HTTP pipeline policy." + name: "policy" + type: "" + syntax: "public ResourceHealthManager.Configurable withPolicy(HttpPipelinePolicy policy)" + desc: "Adds the pipeline policy to the HTTP pipeline." + returns: + description: "the configurable object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withRetryOptions(com.azure.core.http.policy.RetryOptions)" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withRetryOptions(RetryOptions retryOptions)" + name: "withRetryOptions(RetryOptions retryOptions)" + nameWithType: "ResourceHealthManager.Configurable.withRetryOptions(RetryOptions retryOptions)" + summary: "Sets the retry options for the HTTP pipeline retry policy." + parameters: + - description: "the retry options for the HTTP pipeline retry policy." + name: "retryOptions" + type: "" + syntax: "public ResourceHealthManager.Configurable withRetryOptions(RetryOptions retryOptions)" + desc: "Sets the retry options for the HTTP pipeline retry policy.\n\nThis setting has no effect, if retry policy is set via ." + returns: + description: "the configurable object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withRetryPolicy(com.azure.core.http.policy.RetryPolicy)" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withRetryPolicy(RetryPolicy retryPolicy)" + name: "withRetryPolicy(RetryPolicy retryPolicy)" + nameWithType: "ResourceHealthManager.Configurable.withRetryPolicy(RetryPolicy retryPolicy)" + summary: "Sets the retry policy to the HTTP pipeline." + parameters: + - description: "the HTTP pipeline retry policy." + name: "retryPolicy" + type: "" + syntax: "public ResourceHealthManager.Configurable withRetryPolicy(RetryPolicy retryPolicy)" + desc: "Sets the retry policy to the HTTP pipeline." + returns: + description: "the configurable object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withScope(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable.withScope(String scope)" + name: "withScope(String scope)" + nameWithType: "ResourceHealthManager.Configurable.withScope(String scope)" + summary: "Adds the scope to permission sets." + parameters: + - description: "the scope." + name: "scope" + type: "String" + syntax: "public ResourceHealthManager.Configurable withScope(String scope)" + desc: "Adds the scope to permission sets." + returns: + description: "the configurable object itself." + type: "" +type: "class" +desc: "The Configurable allowing configurations to be set." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.ResourceHealthManager.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.ResourceHealthManager.yml new file mode 100644 index 000000000000..99aaff58636e --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.ResourceHealthManager.yml @@ -0,0 +1,107 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager" +fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager" +name: "ResourceHealthManager" +nameWithType: "ResourceHealthManager" +summary: "Entry point to ResourceHealthManager." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **ResourceHealthManager**" +methods: +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.authenticate(com.azure.core.credential.TokenCredential,com.azure.core.management.profile.AzureProfile)" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.authenticate(TokenCredential credential, AzureProfile profile)" + name: "authenticate(TokenCredential credential, AzureProfile profile)" + nameWithType: "ResourceHealthManager.authenticate(TokenCredential credential, AzureProfile profile)" + summary: "Creates an instance of ResourceHealth service API entry point." + modifiers: + - "static" + parameters: + - description: "the credential to use." + name: "credential" + type: "" + - description: "the Azure profile for client." + name: "profile" + type: "" + syntax: "public static ResourceHealthManager authenticate(TokenCredential credential, AzureProfile profile)" + desc: "Creates an instance of ResourceHealth service API entry point." + returns: + description: "the ResourceHealth service API instance." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.authenticate(com.azure.core.http.HttpPipeline,com.azure.core.management.profile.AzureProfile)" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.authenticate(HttpPipeline httpPipeline, AzureProfile profile)" + name: "authenticate(HttpPipeline httpPipeline, AzureProfile profile)" + nameWithType: "ResourceHealthManager.authenticate(HttpPipeline httpPipeline, AzureProfile profile)" + summary: "Creates an instance of ResourceHealth service API entry point." + modifiers: + - "static" + parameters: + - description: "the configured with Azure authentication credential." + name: "httpPipeline" + type: "" + - description: "the Azure profile for client." + name: "profile" + type: "" + syntax: "public static ResourceHealthManager authenticate(HttpPipeline httpPipeline, AzureProfile profile)" + desc: "Creates an instance of ResourceHealth service API entry point." + returns: + description: "the ResourceHealth service API instance." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.availabilityStatuses()" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.availabilityStatuses()" + name: "availabilityStatuses()" + nameWithType: "ResourceHealthManager.availabilityStatuses()" + summary: "Gets the resource collection API of AvailabilityStatuses." + syntax: "public AvailabilityStatuses availabilityStatuses()" + desc: "Gets the resource collection API of AvailabilityStatuses." + returns: + description: "Resource collection API of AvailabilityStatuses." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.configure()" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.configure()" + name: "configure()" + nameWithType: "ResourceHealthManager.configure()" + summary: "Gets a Configurable instance that can be used to create ResourceHealthManager with optional configuration." + modifiers: + - "static" + syntax: "public static ResourceHealthManager.Configurable configure()" + desc: "Gets a Configurable instance that can be used to create ResourceHealthManager with optional configuration." + returns: + description: "the Configurable instance allowing configurations." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.operations()" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.operations()" + name: "operations()" + nameWithType: "ResourceHealthManager.operations()" + summary: "Gets the resource collection API of Operations." + syntax: "public Operations operations()" + desc: "Gets the resource collection API of Operations." + returns: + description: "Resource collection API of Operations." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.serviceClient()" + fullName: "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.serviceClient()" + name: "serviceClient()" + nameWithType: "ResourceHealthManager.serviceClient()" + syntax: "public MicrosoftResourceHealth serviceClient()" + returns: + description: "Wrapped service client MicrosoftResourceHealth providing direct access to the underlying auto-generated\n API implementation, based on Azure REST API." + type: "" +type: "class" +desc: "Entry point to ResourceHealthManager. The Resource Health Client." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.yml new file mode 100644 index 000000000000..175ef4ab84fb --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.yml @@ -0,0 +1,170 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient" +fullName: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient" +name: "AvailabilityStatusesClient" +nameWithType: "AvailabilityStatusesClient" +summary: "An instance of this class provides access to all the operations defined in AvailabilityStatusesClient." +syntax: "public interface **AvailabilityStatusesClient**" +methods: +- uid: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.getByResource(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.getByResource(String resourceUri)" + name: "getByResource(String resourceUri)" + nameWithType: "AvailabilityStatusesClient.getByResource(String resourceUri)" + summary: "Gets current availability status for a single resource." + modifiers: + - "abstract" + parameters: + - description: "The fully qualified ID of the resource, including the resource name and resource type.\n Currently the API support not nested and one nesting level resource types :\n /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}\n and\n /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}." + name: "resourceUri" + type: "String" + syntax: "public abstract AvailabilityStatusInner getByResource(String resourceUri)" + desc: "Gets current availability status for a single resource." + returns: + description: "current availability status for a single resource." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.getByResourceWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.getByResourceWithResponse(String resourceUri, String filter, String expand, Context context)" + name: "getByResourceWithResponse(String resourceUri, String filter, String expand, Context context)" + nameWithType: "AvailabilityStatusesClient.getByResourceWithResponse(String resourceUri, String filter, String expand, Context context)" + summary: "Gets current availability status for a single resource." + modifiers: + - "abstract" + parameters: + - description: "The fully qualified ID of the resource, including the resource name and resource type.\n Currently the API support not nested and one nesting level resource types :\n /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}\n and\n /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}." + name: "resourceUri" + type: "String" + - description: "The filter to apply on the operation. For more information please see\n https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN." + name: "filter" + type: "String" + - description: "Setting $expand=recommendedactions in url query expands the recommendedactions in the response." + name: "expand" + type: "String" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public abstract Response getByResourceWithResponse(String resourceUri, String filter, String expand, Context context)" + desc: "Gets current availability status for a single resource." + returns: + description: "current availability status for a single resource along with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.list(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.list(String resourceUri)" + name: "list(String resourceUri)" + nameWithType: "AvailabilityStatusesClient.list(String resourceUri)" + summary: "Lists all historical availability transitions and impacting events for a single resource." + modifiers: + - "abstract" + parameters: + - description: "The fully qualified ID of the resource, including the resource name and resource type.\n Currently the API support not nested and one nesting level resource types :\n /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}\n and\n /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}." + name: "resourceUri" + type: "String" + syntax: "public abstract PagedIterable list(String resourceUri)" + desc: "Lists all historical availability transitions and impacting events for a single resource." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.list(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.list(String resourceUri, String filter, String expand, Context context)" + name: "list(String resourceUri, String filter, String expand, Context context)" + nameWithType: "AvailabilityStatusesClient.list(String resourceUri, String filter, String expand, Context context)" + summary: "Lists all historical availability transitions and impacting events for a single resource." + modifiers: + - "abstract" + parameters: + - description: "The fully qualified ID of the resource, including the resource name and resource type.\n Currently the API support not nested and one nesting level resource types :\n /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}\n and\n /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}." + name: "resourceUri" + type: "String" + - description: "The filter to apply on the operation. For more information please see\n https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN." + name: "filter" + type: "String" + - description: "Setting $expand=recommendedactions in url query expands the recommendedactions in the response." + name: "expand" + type: "String" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public abstract PagedIterable list(String resourceUri, String filter, String expand, Context context)" + desc: "Lists all historical availability transitions and impacting events for a single resource." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.listByResourceGroup(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.listByResourceGroup(String resourceGroupName)" + name: "listByResourceGroup(String resourceGroupName)" + nameWithType: "AvailabilityStatusesClient.listByResourceGroup(String resourceGroupName)" + summary: "Lists the current availability status for all the resources in the resource group." + modifiers: + - "abstract" + parameters: + - description: "The name of the resource group." + name: "resourceGroupName" + type: "String" + syntax: "public abstract PagedIterable listByResourceGroup(String resourceGroupName)" + desc: "Lists the current availability status for all the resources in the resource group." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.listByResourceGroup(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.listByResourceGroup(String resourceGroupName, String filter, String expand, Context context)" + name: "listByResourceGroup(String resourceGroupName, String filter, String expand, Context context)" + nameWithType: "AvailabilityStatusesClient.listByResourceGroup(String resourceGroupName, String filter, String expand, Context context)" + summary: "Lists the current availability status for all the resources in the resource group." + modifiers: + - "abstract" + parameters: + - description: "The name of the resource group." + name: "resourceGroupName" + type: "String" + - description: "The filter to apply on the operation. For more information please see\n https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN." + name: "filter" + type: "String" + - description: "Setting $expand=recommendedactions in url query expands the recommendedactions in the response." + name: "expand" + type: "String" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public abstract PagedIterable listByResourceGroup(String resourceGroupName, String filter, String expand, Context context)" + desc: "Lists the current availability status for all the resources in the resource group." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.listBySubscriptionId()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.listBySubscriptionId()" + name: "listBySubscriptionId()" + nameWithType: "AvailabilityStatusesClient.listBySubscriptionId()" + summary: "Lists the current availability status for all the resources in the subscription." + modifiers: + - "abstract" + syntax: "public abstract PagedIterable listBySubscriptionId()" + desc: "Lists the current availability status for all the resources in the subscription." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.listBySubscriptionId(java.lang.String,java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient.listBySubscriptionId(String filter, String expand, Context context)" + name: "listBySubscriptionId(String filter, String expand, Context context)" + nameWithType: "AvailabilityStatusesClient.listBySubscriptionId(String filter, String expand, Context context)" + summary: "Lists the current availability status for all the resources in the subscription." + modifiers: + - "abstract" + parameters: + - description: "The filter to apply on the operation. For more information please see\n https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN." + name: "filter" + type: "String" + - description: "Setting $expand=recommendedactions in url query expands the recommendedactions in the response." + name: "expand" + type: "String" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public abstract PagedIterable listBySubscriptionId(String filter, String expand, Context context)" + desc: "Lists the current availability status for all the resources in the subscription." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +type: "interface" +desc: "An instance of this class provides access to all the operations defined in AvailabilityStatusesClient." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.fluent" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.yml new file mode 100644 index 000000000000..b894b63c6f88 --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.yml @@ -0,0 +1,97 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth" +fullName: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth" +name: "MicrosoftResourceHealth" +nameWithType: "MicrosoftResourceHealth" +summary: "The interface for MicrosoftResourceHealth class." +syntax: "public interface **MicrosoftResourceHealth**" +methods: +- uid: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getApiVersion()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getApiVersion()" + name: "getApiVersion()" + nameWithType: "MicrosoftResourceHealth.getApiVersion()" + summary: "Gets Api Version." + modifiers: + - "abstract" + syntax: "public abstract String getApiVersion()" + desc: "Gets Api Version." + returns: + description: "the apiVersion value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getAvailabilityStatuses()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getAvailabilityStatuses()" + name: "getAvailabilityStatuses()" + nameWithType: "MicrosoftResourceHealth.getAvailabilityStatuses()" + summary: "Gets the AvailabilityStatusesClient object to access its operations." + modifiers: + - "abstract" + syntax: "public abstract AvailabilityStatusesClient getAvailabilityStatuses()" + desc: "Gets the AvailabilityStatusesClient object to access its operations." + returns: + description: "the AvailabilityStatusesClient object." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getDefaultPollInterval()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getDefaultPollInterval()" + name: "getDefaultPollInterval()" + nameWithType: "MicrosoftResourceHealth.getDefaultPollInterval()" + summary: "Gets The default poll interval for long-running operation." + modifiers: + - "abstract" + syntax: "public abstract Duration getDefaultPollInterval()" + desc: "Gets The default poll interval for long-running operation." + returns: + description: "the defaultPollInterval value." + type: "Duration" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getEndpoint()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getEndpoint()" + name: "getEndpoint()" + nameWithType: "MicrosoftResourceHealth.getEndpoint()" + summary: "Gets server parameter." + modifiers: + - "abstract" + syntax: "public abstract String getEndpoint()" + desc: "Gets server parameter." + returns: + description: "the endpoint value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getHttpPipeline()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getHttpPipeline()" + name: "getHttpPipeline()" + nameWithType: "MicrosoftResourceHealth.getHttpPipeline()" + summary: "Gets The HTTP pipeline to send requests through." + modifiers: + - "abstract" + syntax: "public abstract HttpPipeline getHttpPipeline()" + desc: "Gets The HTTP pipeline to send requests through." + returns: + description: "the httpPipeline value." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getOperations()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getOperations()" + name: "getOperations()" + nameWithType: "MicrosoftResourceHealth.getOperations()" + summary: "Gets the OperationsClient object to access its operations." + modifiers: + - "abstract" + syntax: "public abstract OperationsClient getOperations()" + desc: "Gets the OperationsClient object to access its operations." + returns: + description: "the OperationsClient object." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getSubscriptionId()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth.getSubscriptionId()" + name: "getSubscriptionId()" + nameWithType: "MicrosoftResourceHealth.getSubscriptionId()" + summary: "Gets Subscription credentials which uniquely identify Microsoft Azure subscription." + modifiers: + - "abstract" + syntax: "public abstract String getSubscriptionId()" + desc: "Gets Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + returns: + description: "the subscriptionId value." + type: "String" +type: "interface" +desc: "The interface for MicrosoftResourceHealth class." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.fluent" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.OperationsClient.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.OperationsClient.yml new file mode 100644 index 000000000000..63646faa3be3 --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.OperationsClient.yml @@ -0,0 +1,41 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.fluent.OperationsClient" +fullName: "com.azure.resourcemanager.resourcehealth.fluent.OperationsClient" +name: "OperationsClient" +nameWithType: "OperationsClient" +summary: "An instance of this class provides access to all the operations defined in OperationsClient." +syntax: "public interface **OperationsClient**" +methods: +- uid: "com.azure.resourcemanager.resourcehealth.fluent.OperationsClient.list()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.OperationsClient.list()" + name: "list()" + nameWithType: "OperationsClient.list()" + summary: "Lists available operations for the resourcehealth resource provider." + modifiers: + - "abstract" + syntax: "public abstract OperationListResultInner list()" + desc: "Lists available operations for the resourcehealth resource provider." + returns: + description: "lists the operations response." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.OperationsClient.listWithResponse(com.azure.core.util.Context)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.OperationsClient.listWithResponse(Context context)" + name: "listWithResponse(Context context)" + nameWithType: "OperationsClient.listWithResponse(Context context)" + summary: "Lists available operations for the resourcehealth resource provider." + modifiers: + - "abstract" + parameters: + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public abstract Response listWithResponse(Context context)" + desc: "Lists available operations for the resourcehealth resource provider." + returns: + description: "lists the operations response along with ." + type: "<>" +type: "interface" +desc: "An instance of this class provides access to all the operations defined in OperationsClient." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.fluent" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.yml new file mode 100644 index 000000000000..67c98e748bea --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.yml @@ -0,0 +1,164 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner" +fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner" +name: "AvailabilityStatusInner" +nameWithType: "AvailabilityStatusInner" +summary: "availabilityStatus of a resource." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **AvailabilityStatusInner**" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.AvailabilityStatusInner()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.AvailabilityStatusInner()" + name: "AvailabilityStatusInner()" + nameWithType: "AvailabilityStatusInner.AvailabilityStatusInner()" + summary: "Creates an instance of AvailabilityStatusInner class." + syntax: "public AvailabilityStatusInner()" + desc: "Creates an instance of AvailabilityStatusInner class." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.id()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.id()" + name: "id()" + nameWithType: "AvailabilityStatusInner.id()" + summary: "Get the id property: Azure Resource Manager Identity for the availabilityStatuses resource." + syntax: "public String id()" + desc: "Get the id property: Azure Resource Manager Identity for the availabilityStatuses resource." + returns: + description: "the id value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.location()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.location()" + name: "location()" + nameWithType: "AvailabilityStatusInner.location()" + summary: "Get the location property: Azure Resource Manager geo location of the resource." + syntax: "public String location()" + desc: "Get the location property: Azure Resource Manager geo location of the resource." + returns: + description: "the location value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.name()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.name()" + name: "name()" + nameWithType: "AvailabilityStatusInner.name()" + summary: "Get the name property: current." + syntax: "public String name()" + desc: "Get the name property: current." + returns: + description: "the name value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.properties()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.properties()" + name: "properties()" + nameWithType: "AvailabilityStatusInner.properties()" + summary: "Get the properties property: Properties of availability state." + syntax: "public AvailabilityStatusProperties properties()" + desc: "Get the properties property: Properties of availability state." + returns: + description: "the properties value." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.type()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.type()" + name: "type()" + nameWithType: "AvailabilityStatusInner.type()" + summary: "Get the type property: Microsoft.ResourceHealth/AvailabilityStatuses." + syntax: "public String type()" + desc: "Get the type property: Microsoft.ResourceHealth/AvailabilityStatuses." + returns: + description: "the type value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.validate()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.validate()" + name: "validate()" + nameWithType: "AvailabilityStatusInner.validate()" + summary: "Validates the instance." + syntax: "public void validate()" + desc: "Validates the instance." +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.withId(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.withId(String id)" + name: "withId(String id)" + nameWithType: "AvailabilityStatusInner.withId(String id)" + summary: "Set the id property: Azure Resource Manager Identity for the availabilityStatuses resource." + parameters: + - description: "the id value to set." + name: "id" + type: "String" + syntax: "public AvailabilityStatusInner withId(String id)" + desc: "Set the id property: Azure Resource Manager Identity for the availabilityStatuses resource." + returns: + description: "the AvailabilityStatusInner object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.withLocation(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.withLocation(String location)" + name: "withLocation(String location)" + nameWithType: "AvailabilityStatusInner.withLocation(String location)" + summary: "Set the location property: Azure Resource Manager geo location of the resource." + parameters: + - description: "the location value to set." + name: "location" + type: "String" + syntax: "public AvailabilityStatusInner withLocation(String location)" + desc: "Set the location property: Azure Resource Manager geo location of the resource." + returns: + description: "the AvailabilityStatusInner object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.withName(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.withName(String name)" + name: "withName(String name)" + nameWithType: "AvailabilityStatusInner.withName(String name)" + summary: "Set the name property: current." + parameters: + - description: "the name value to set." + name: "name" + type: "String" + syntax: "public AvailabilityStatusInner withName(String name)" + desc: "Set the name property: current." + returns: + description: "the AvailabilityStatusInner object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.withProperties(com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.withProperties(AvailabilityStatusProperties properties)" + name: "withProperties(AvailabilityStatusProperties properties)" + nameWithType: "AvailabilityStatusInner.withProperties(AvailabilityStatusProperties properties)" + summary: "Set the properties property: Properties of availability state." + parameters: + - description: "the properties value to set." + name: "properties" + type: "" + syntax: "public AvailabilityStatusInner withProperties(AvailabilityStatusProperties properties)" + desc: "Set the properties property: Properties of availability state." + returns: + description: "the AvailabilityStatusInner object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.withType(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner.withType(String type)" + name: "withType(String type)" + nameWithType: "AvailabilityStatusInner.withType(String type)" + summary: "Set the type property: Microsoft.ResourceHealth/AvailabilityStatuses." + parameters: + - description: "the type value to set." + name: "type" + type: "String" + syntax: "public AvailabilityStatusInner withType(String type)" + desc: "Set the type property: Microsoft.ResourceHealth/AvailabilityStatuses." + returns: + description: "the AvailabilityStatusInner object itself." + type: "" +type: "class" +desc: "availabilityStatus of a resource." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.fluent.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.yml new file mode 100644 index 000000000000..6cbc4fd999f3 --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.yml @@ -0,0 +1,68 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner" +fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner" +name: "OperationListResultInner" +nameWithType: "OperationListResultInner" +summary: "Lists the operations response." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **OperationListResultInner**" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.OperationListResultInner()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.OperationListResultInner()" + name: "OperationListResultInner()" + nameWithType: "OperationListResultInner.OperationListResultInner()" + summary: "Creates an instance of OperationListResultInner class." + syntax: "public OperationListResultInner()" + desc: "Creates an instance of OperationListResultInner class." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.validate()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.validate()" + name: "validate()" + nameWithType: "OperationListResultInner.validate()" + summary: "Validates the instance." + syntax: "public void validate()" + desc: "Validates the instance." +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.value()" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.value()" + name: "value()" + nameWithType: "OperationListResultInner.value()" + summary: "Get the value property: List of operations available in the resourcehealth resource provider." + syntax: "public List value()" + desc: "Get the value property: List of operations available in the resourcehealth resource provider." + returns: + description: "the value value." + type: "List<>" +- uid: "com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.withValue(java.util.List)" + fullName: "com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner.withValue(List value)" + name: "withValue(List value)" + nameWithType: "OperationListResultInner.withValue(List value)" + summary: "Set the value property: List of operations available in the resourcehealth resource provider." + parameters: + - description: "the value value to set." + name: "value" + type: "List<>" + syntax: "public OperationListResultInner withValue(List value)" + desc: "Set the value property: List of operations available in the resourcehealth resource provider." + returns: + description: "the OperationListResultInner object itself." + type: "" +type: "class" +desc: "Lists the operations response." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.fluent.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.yml new file mode 100644 index 000000000000..c2a2ddd777d5 --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.models.yml @@ -0,0 +1,12 @@ +### YamlMime:JavaPackage +uid: "com.azure.resourcemanager.resourcehealth.fluent.models" +fullName: "com.azure.resourcemanager.resourcehealth.fluent.models" +name: "com.azure.resourcemanager.resourcehealth.fluent.models" +summary: "Package containing the inner data models for MicrosoftResourceHealth." +classes: +- "com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner" +- "com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner" +desc: "Package containing the inner data models for MicrosoftResourceHealth. The Resource Health Client." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.fluent.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.yml new file mode 100644 index 000000000000..2175d1f6e341 --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.fluent.yml @@ -0,0 +1,13 @@ +### YamlMime:JavaPackage +uid: "com.azure.resourcemanager.resourcehealth.fluent" +fullName: "com.azure.resourcemanager.resourcehealth.fluent" +name: "com.azure.resourcemanager.resourcehealth.fluent" +summary: "Package containing the service clients for MicrosoftResourceHealth." +interfaces: +- "com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient" +- "com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth" +- "com.azure.resourcemanager.resourcehealth.fluent.OperationsClient" +desc: "Package containing the service clients for MicrosoftResourceHealth. The Resource Health Client." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.fluent" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.yml new file mode 100644 index 000000000000..3ef539d44b8f --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.yml @@ -0,0 +1,117 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues" +fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues" +name: "AvailabilityStateValues" +nameWithType: "AvailabilityStateValues" +summary: "Impacted resource status of the resource." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **AvailabilityStateValues**
extends <>" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.AvailabilityStateValues()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.AvailabilityStateValues()" + name: "AvailabilityStateValues()" + nameWithType: "AvailabilityStateValues.AvailabilityStateValues()" + syntax: "public AvailabilityStateValues()" +fields: +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.AVAILABLE" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.AVAILABLE" + name: "AVAILABLE" + nameWithType: "AvailabilityStateValues.AVAILABLE" + summary: "Static value Available for AvailabilityStateValues." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final AvailabilityStateValues AVAILABLE" + desc: "Static value Available for AvailabilityStateValues." +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.DEGRADED" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.DEGRADED" + name: "DEGRADED" + nameWithType: "AvailabilityStateValues.DEGRADED" + summary: "Static value Degraded for AvailabilityStateValues." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final AvailabilityStateValues DEGRADED" + desc: "Static value Degraded for AvailabilityStateValues." +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.UNAVAILABLE" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.UNAVAILABLE" + name: "UNAVAILABLE" + nameWithType: "AvailabilityStateValues.UNAVAILABLE" + summary: "Static value Unavailable for AvailabilityStateValues." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final AvailabilityStateValues UNAVAILABLE" + desc: "Static value Unavailable for AvailabilityStateValues." +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.UNKNOWN" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.UNKNOWN" + name: "UNKNOWN" + nameWithType: "AvailabilityStateValues.UNKNOWN" + summary: "Static value Unknown for AvailabilityStateValues." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final AvailabilityStateValues UNKNOWN" + desc: "Static value Unknown for AvailabilityStateValues." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.fromString(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.fromString(String name)" + name: "fromString(String name)" + nameWithType: "AvailabilityStateValues.fromString(String name)" + summary: "Creates or finds a AvailabilityStateValues from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static AvailabilityStateValues fromString(String name)" + desc: "Creates or finds a AvailabilityStateValues from its string representation." + returns: + description: "the corresponding AvailabilityStateValues." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.values()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues.values()" + name: "values()" + nameWithType: "AvailabilityStateValues.values()" + summary: "Gets known AvailabilityStateValues values." + modifiers: + - "static" + syntax: "public static Collection values()" + desc: "Gets known AvailabilityStateValues values." + returns: + description: "known AvailabilityStateValues values." + type: "Collection<>" +type: "class" +desc: "Impacted resource status of the resource." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.yml new file mode 100644 index 000000000000..ea086a49569f --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.yml @@ -0,0 +1,85 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus" +fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus" +name: "AvailabilityStatus" +nameWithType: "AvailabilityStatus" +summary: "An immutable client-side representation of AvailabilityStatus." +syntax: "public interface **AvailabilityStatus**" +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.id()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.id()" + name: "id()" + nameWithType: "AvailabilityStatus.id()" + summary: "Gets the id property: Azure Resource Manager Identity for the availabilityStatuses resource." + modifiers: + - "abstract" + syntax: "public abstract String id()" + desc: "Gets the id property: Azure Resource Manager Identity for the availabilityStatuses resource." + returns: + description: "the id value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.innerModel()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.innerModel()" + name: "innerModel()" + nameWithType: "AvailabilityStatus.innerModel()" + summary: "Gets the inner com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner object." + modifiers: + - "abstract" + syntax: "public abstract AvailabilityStatusInner innerModel()" + desc: "Gets the inner com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner object." + returns: + description: "the inner object." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.location()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.location()" + name: "location()" + nameWithType: "AvailabilityStatus.location()" + summary: "Gets the location property: Azure Resource Manager geo location of the resource." + modifiers: + - "abstract" + syntax: "public abstract String location()" + desc: "Gets the location property: Azure Resource Manager geo location of the resource." + returns: + description: "the location value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.name()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.name()" + name: "name()" + nameWithType: "AvailabilityStatus.name()" + summary: "Gets the name property: current." + modifiers: + - "abstract" + syntax: "public abstract String name()" + desc: "Gets the name property: current." + returns: + description: "the name value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.properties()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.properties()" + name: "properties()" + nameWithType: "AvailabilityStatus.properties()" + summary: "Gets the properties property: Properties of availability state." + modifiers: + - "abstract" + syntax: "public abstract AvailabilityStatusProperties properties()" + desc: "Gets the properties property: Properties of availability state." + returns: + description: "the properties value." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.type()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus.type()" + name: "type()" + nameWithType: "AvailabilityStatus.type()" + summary: "Gets the type property: Microsoft.ResourceHealth/AvailabilityStatuses." + modifiers: + - "abstract" + syntax: "public abstract String type()" + desc: "Gets the type property: Microsoft.ResourceHealth/AvailabilityStatuses." + returns: + description: "the type value." + type: "String" +type: "interface" +desc: "An immutable client-side representation of AvailabilityStatus." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.yml new file mode 100644 index 000000000000..0b51fd47248b --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.yml @@ -0,0 +1,92 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult" +fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult" +name: "AvailabilityStatusListResult" +nameWithType: "AvailabilityStatusListResult" +summary: "The List availabilityStatus operation response." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **AvailabilityStatusListResult**" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.AvailabilityStatusListResult()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.AvailabilityStatusListResult()" + name: "AvailabilityStatusListResult()" + nameWithType: "AvailabilityStatusListResult.AvailabilityStatusListResult()" + summary: "Creates an instance of AvailabilityStatusListResult class." + syntax: "public AvailabilityStatusListResult()" + desc: "Creates an instance of AvailabilityStatusListResult class." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.nextLink()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.nextLink()" + name: "nextLink()" + nameWithType: "AvailabilityStatusListResult.nextLink()" + summary: "Get the nextLink property: The URI to fetch the next page of availabilityStatuses." + syntax: "public String nextLink()" + desc: "Get the nextLink property: The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses." + returns: + description: "the nextLink value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.validate()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.validate()" + name: "validate()" + nameWithType: "AvailabilityStatusListResult.validate()" + summary: "Validates the instance." + syntax: "public void validate()" + desc: "Validates the instance." +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.value()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.value()" + name: "value()" + nameWithType: "AvailabilityStatusListResult.value()" + summary: "Get the value property: The list of availabilityStatuses." + syntax: "public List value()" + desc: "Get the value property: The list of availabilityStatuses." + returns: + description: "the value value." + type: "List<>" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.withNextLink(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.withNextLink(String nextLink)" + name: "withNextLink(String nextLink)" + nameWithType: "AvailabilityStatusListResult.withNextLink(String nextLink)" + summary: "Set the nextLink property: The URI to fetch the next page of availabilityStatuses." + parameters: + - description: "the nextLink value to set." + name: "nextLink" + type: "String" + syntax: "public AvailabilityStatusListResult withNextLink(String nextLink)" + desc: "Set the nextLink property: The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses." + returns: + description: "the AvailabilityStatusListResult object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.withValue(java.util.List)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult.withValue(List value)" + name: "withValue(List value)" + nameWithType: "AvailabilityStatusListResult.withValue(List value)" + summary: "Set the value property: The list of availabilityStatuses." + parameters: + - description: "the value value to set." + name: "value" + type: "List<>" + syntax: "public AvailabilityStatusListResult withValue(List value)" + desc: "Set the value property: The list of availabilityStatuses." + returns: + description: "the AvailabilityStatusListResult object itself." + type: "" +type: "class" +desc: "The List availabilityStatus operation response." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.yml new file mode 100644 index 000000000000..47ff6caf5c9a --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.yml @@ -0,0 +1,452 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties" +fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties" +name: "AvailabilityStatusProperties" +nameWithType: "AvailabilityStatusProperties" +summary: "Properties of availability state." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **AvailabilityStatusProperties**" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.AvailabilityStatusProperties()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.AvailabilityStatusProperties()" + name: "AvailabilityStatusProperties()" + nameWithType: "AvailabilityStatusProperties.AvailabilityStatusProperties()" + summary: "Creates an instance of AvailabilityStatusProperties class." + syntax: "public AvailabilityStatusProperties()" + desc: "Creates an instance of AvailabilityStatusProperties class." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.availabilityState()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.availabilityState()" + name: "availabilityState()" + nameWithType: "AvailabilityStatusProperties.availabilityState()" + summary: "Get the availabilityState property: Availability status of the resource." + syntax: "public AvailabilityStateValues availabilityState()" + desc: "Get the availabilityState property: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event." + returns: + description: "the availabilityState value." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.detailedStatus()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.detailedStatus()" + name: "detailedStatus()" + nameWithType: "AvailabilityStatusProperties.detailedStatus()" + summary: "Get the detailedStatus property: Details of the availability status." + syntax: "public String detailedStatus()" + desc: "Get the detailedStatus property: Details of the availability status." + returns: + description: "the detailedStatus value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.healthEventCategory()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.healthEventCategory()" + name: "healthEventCategory()" + nameWithType: "AvailabilityStatusProperties.healthEventCategory()" + summary: "Get the healthEventCategory property: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event." + syntax: "public String healthEventCategory()" + desc: "Get the healthEventCategory property: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc." + returns: + description: "the healthEventCategory value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.healthEventCause()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.healthEventCause()" + name: "healthEventCause()" + nameWithType: "AvailabilityStatusProperties.healthEventCause()" + summary: "Get the healthEventCause property: In case of an availability impacting event, it describes where the health impacting event was originated." + syntax: "public String healthEventCause()" + desc: "Get the healthEventCause property: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc." + returns: + description: "the healthEventCause value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.healthEventId()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.healthEventId()" + name: "healthEventId()" + nameWithType: "AvailabilityStatusProperties.healthEventId()" + summary: "Get the healthEventId property: It is a unique Id that identifies the event." + syntax: "public String healthEventId()" + desc: "Get the healthEventId property: It is a unique Id that identifies the event." + returns: + description: "the healthEventId value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.healthEventType()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.healthEventType()" + name: "healthEventType()" + nameWithType: "AvailabilityStatusProperties.healthEventType()" + summary: "Get the healthEventType property: In case of an availability impacting event, it describes when the health impacting event was originated." + syntax: "public String healthEventType()" + desc: "Get the healthEventType property: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc." + returns: + description: "the healthEventType value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.occuredTime()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.occuredTime()" + name: "occuredTime()" + nameWithType: "AvailabilityStatusProperties.occuredTime()" + summary: "Get the occuredTime property: Timestamp for when last change in health status occurred." + syntax: "public OffsetDateTime occuredTime()" + desc: "Get the occuredTime property: Timestamp for when last change in health status occurred." + returns: + description: "the occuredTime value." + type: "OffsetDateTime" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.reasonChronicity()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.reasonChronicity()" + name: "reasonChronicity()" + nameWithType: "AvailabilityStatusProperties.reasonChronicity()" + summary: "Get the reasonChronicity property: Chronicity of the availability transition." + syntax: "public ReasonChronicityTypes reasonChronicity()" + desc: "Get the reasonChronicity property: Chronicity of the availability transition." + returns: + description: "the reasonChronicity value." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.reasonType()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.reasonType()" + name: "reasonType()" + nameWithType: "AvailabilityStatusProperties.reasonType()" + summary: "Get the reasonType property: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated." + syntax: "public String reasonType()" + desc: "Get the reasonType property: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc." + returns: + description: "the reasonType value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.recentlyResolved()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.recentlyResolved()" + name: "recentlyResolved()" + nameWithType: "AvailabilityStatusProperties.recentlyResolved()" + summary: "Get the recentlyResolved property: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned." + syntax: "public AvailabilityStatusPropertiesRecentlyResolved recentlyResolved()" + desc: "Get the recentlyResolved property: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned." + returns: + description: "the recentlyResolved value." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.recommendedActions()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.recommendedActions()" + name: "recommendedActions()" + nameWithType: "AvailabilityStatusProperties.recommendedActions()" + summary: "Get the recommendedActions property: Lists actions the user can take based on the current availabilityState of the resource." + syntax: "public List recommendedActions()" + desc: "Get the recommendedActions property: Lists actions the user can take based on the current availabilityState of the resource." + returns: + description: "the recommendedActions value." + type: "List<>" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.reportedTime()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.reportedTime()" + name: "reportedTime()" + nameWithType: "AvailabilityStatusProperties.reportedTime()" + summary: "Get the reportedTime property: Timestamp for when the health was last checked." + syntax: "public OffsetDateTime reportedTime()" + desc: "Get the reportedTime property: Timestamp for when the health was last checked." + returns: + description: "the reportedTime value." + type: "OffsetDateTime" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.resolutionEta()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.resolutionEta()" + name: "resolutionEta()" + nameWithType: "AvailabilityStatusProperties.resolutionEta()" + summary: "Get the resolutionEta property: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved." + syntax: "public OffsetDateTime resolutionEta()" + desc: "Get the resolutionEta property: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved." + returns: + description: "the resolutionEta value." + type: "OffsetDateTime" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.rootCauseAttributionTime()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.rootCauseAttributionTime()" + name: "rootCauseAttributionTime()" + nameWithType: "AvailabilityStatusProperties.rootCauseAttributionTime()" + summary: "Get the rootCauseAttributionTime property: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received." + syntax: "public OffsetDateTime rootCauseAttributionTime()" + desc: "Get the rootCauseAttributionTime property: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received." + returns: + description: "the rootCauseAttributionTime value." + type: "OffsetDateTime" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.serviceImpactingEvents()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.serviceImpactingEvents()" + name: "serviceImpactingEvents()" + nameWithType: "AvailabilityStatusProperties.serviceImpactingEvents()" + summary: "Get the serviceImpactingEvents property: Lists the service impacting events that may be affecting the health of the resource." + syntax: "public List serviceImpactingEvents()" + desc: "Get the serviceImpactingEvents property: Lists the service impacting events that may be affecting the health of the resource." + returns: + description: "the serviceImpactingEvents value." + type: "List<>" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.summary()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.summary()" + name: "summary()" + nameWithType: "AvailabilityStatusProperties.summary()" + summary: "Get the summary property: Summary description of the availability status." + syntax: "public String summary()" + desc: "Get the summary property: Summary description of the availability status." + returns: + description: "the summary value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.title()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.title()" + name: "title()" + nameWithType: "AvailabilityStatusProperties.title()" + summary: "Get the title property: Title description of the availability status." + syntax: "public String title()" + desc: "Get the title property: Title description of the availability status." + returns: + description: "the title value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.validate()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.validate()" + name: "validate()" + nameWithType: "AvailabilityStatusProperties.validate()" + summary: "Validates the instance." + syntax: "public void validate()" + desc: "Validates the instance." +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withAvailabilityState(com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withAvailabilityState(AvailabilityStateValues availabilityState)" + name: "withAvailabilityState(AvailabilityStateValues availabilityState)" + nameWithType: "AvailabilityStatusProperties.withAvailabilityState(AvailabilityStateValues availabilityState)" + summary: "Set the availabilityState property: Availability status of the resource." + parameters: + - description: "the availabilityState value to set." + name: "availabilityState" + type: "" + syntax: "public AvailabilityStatusProperties withAvailabilityState(AvailabilityStateValues availabilityState)" + desc: "Set the availabilityState property: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withDetailedStatus(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withDetailedStatus(String detailedStatus)" + name: "withDetailedStatus(String detailedStatus)" + nameWithType: "AvailabilityStatusProperties.withDetailedStatus(String detailedStatus)" + summary: "Set the detailedStatus property: Details of the availability status." + parameters: + - description: "the detailedStatus value to set." + name: "detailedStatus" + type: "String" + syntax: "public AvailabilityStatusProperties withDetailedStatus(String detailedStatus)" + desc: "Set the detailedStatus property: Details of the availability status." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withHealthEventCategory(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withHealthEventCategory(String healthEventCategory)" + name: "withHealthEventCategory(String healthEventCategory)" + nameWithType: "AvailabilityStatusProperties.withHealthEventCategory(String healthEventCategory)" + summary: "Set the healthEventCategory property: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event." + parameters: + - description: "the healthEventCategory value to set." + name: "healthEventCategory" + type: "String" + syntax: "public AvailabilityStatusProperties withHealthEventCategory(String healthEventCategory)" + desc: "Set the healthEventCategory property: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withHealthEventCause(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withHealthEventCause(String healthEventCause)" + name: "withHealthEventCause(String healthEventCause)" + nameWithType: "AvailabilityStatusProperties.withHealthEventCause(String healthEventCause)" + summary: "Set the healthEventCause property: In case of an availability impacting event, it describes where the health impacting event was originated." + parameters: + - description: "the healthEventCause value to set." + name: "healthEventCause" + type: "String" + syntax: "public AvailabilityStatusProperties withHealthEventCause(String healthEventCause)" + desc: "Set the healthEventCause property: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withHealthEventId(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withHealthEventId(String healthEventId)" + name: "withHealthEventId(String healthEventId)" + nameWithType: "AvailabilityStatusProperties.withHealthEventId(String healthEventId)" + summary: "Set the healthEventId property: It is a unique Id that identifies the event." + parameters: + - description: "the healthEventId value to set." + name: "healthEventId" + type: "String" + syntax: "public AvailabilityStatusProperties withHealthEventId(String healthEventId)" + desc: "Set the healthEventId property: It is a unique Id that identifies the event." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withHealthEventType(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withHealthEventType(String healthEventType)" + name: "withHealthEventType(String healthEventType)" + nameWithType: "AvailabilityStatusProperties.withHealthEventType(String healthEventType)" + summary: "Set the healthEventType property: In case of an availability impacting event, it describes when the health impacting event was originated." + parameters: + - description: "the healthEventType value to set." + name: "healthEventType" + type: "String" + syntax: "public AvailabilityStatusProperties withHealthEventType(String healthEventType)" + desc: "Set the healthEventType property: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withOccuredTime(java.time.OffsetDateTime)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withOccuredTime(OffsetDateTime occuredTime)" + name: "withOccuredTime(OffsetDateTime occuredTime)" + nameWithType: "AvailabilityStatusProperties.withOccuredTime(OffsetDateTime occuredTime)" + summary: "Set the occuredTime property: Timestamp for when last change in health status occurred." + parameters: + - description: "the occuredTime value to set." + name: "occuredTime" + type: "OffsetDateTime" + syntax: "public AvailabilityStatusProperties withOccuredTime(OffsetDateTime occuredTime)" + desc: "Set the occuredTime property: Timestamp for when last change in health status occurred." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withReasonChronicity(com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withReasonChronicity(ReasonChronicityTypes reasonChronicity)" + name: "withReasonChronicity(ReasonChronicityTypes reasonChronicity)" + nameWithType: "AvailabilityStatusProperties.withReasonChronicity(ReasonChronicityTypes reasonChronicity)" + summary: "Set the reasonChronicity property: Chronicity of the availability transition." + parameters: + - description: "the reasonChronicity value to set." + name: "reasonChronicity" + type: "" + syntax: "public AvailabilityStatusProperties withReasonChronicity(ReasonChronicityTypes reasonChronicity)" + desc: "Set the reasonChronicity property: Chronicity of the availability transition." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withReasonType(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withReasonType(String reasonType)" + name: "withReasonType(String reasonType)" + nameWithType: "AvailabilityStatusProperties.withReasonType(String reasonType)" + summary: "Set the reasonType property: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated." + parameters: + - description: "the reasonType value to set." + name: "reasonType" + type: "String" + syntax: "public AvailabilityStatusProperties withReasonType(String reasonType)" + desc: "Set the reasonType property: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withRecentlyResolved(com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withRecentlyResolved(AvailabilityStatusPropertiesRecentlyResolved recentlyResolved)" + name: "withRecentlyResolved(AvailabilityStatusPropertiesRecentlyResolved recentlyResolved)" + nameWithType: "AvailabilityStatusProperties.withRecentlyResolved(AvailabilityStatusPropertiesRecentlyResolved recentlyResolved)" + summary: "Set the recentlyResolved property: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned." + parameters: + - description: "the recentlyResolved value to set." + name: "recentlyResolved" + type: "" + syntax: "public AvailabilityStatusProperties withRecentlyResolved(AvailabilityStatusPropertiesRecentlyResolved recentlyResolved)" + desc: "Set the recentlyResolved property: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withRecommendedActions(java.util.List)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withRecommendedActions(List recommendedActions)" + name: "withRecommendedActions(List recommendedActions)" + nameWithType: "AvailabilityStatusProperties.withRecommendedActions(List recommendedActions)" + summary: "Set the recommendedActions property: Lists actions the user can take based on the current availabilityState of the resource." + parameters: + - description: "the recommendedActions value to set." + name: "recommendedActions" + type: "List<>" + syntax: "public AvailabilityStatusProperties withRecommendedActions(List recommendedActions)" + desc: "Set the recommendedActions property: Lists actions the user can take based on the current availabilityState of the resource." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withReportedTime(java.time.OffsetDateTime)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withReportedTime(OffsetDateTime reportedTime)" + name: "withReportedTime(OffsetDateTime reportedTime)" + nameWithType: "AvailabilityStatusProperties.withReportedTime(OffsetDateTime reportedTime)" + summary: "Set the reportedTime property: Timestamp for when the health was last checked." + parameters: + - description: "the reportedTime value to set." + name: "reportedTime" + type: "OffsetDateTime" + syntax: "public AvailabilityStatusProperties withReportedTime(OffsetDateTime reportedTime)" + desc: "Set the reportedTime property: Timestamp for when the health was last checked." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withResolutionEta(java.time.OffsetDateTime)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withResolutionEta(OffsetDateTime resolutionEta)" + name: "withResolutionEta(OffsetDateTime resolutionEta)" + nameWithType: "AvailabilityStatusProperties.withResolutionEta(OffsetDateTime resolutionEta)" + summary: "Set the resolutionEta property: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved." + parameters: + - description: "the resolutionEta value to set." + name: "resolutionEta" + type: "OffsetDateTime" + syntax: "public AvailabilityStatusProperties withResolutionEta(OffsetDateTime resolutionEta)" + desc: "Set the resolutionEta property: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withRootCauseAttributionTime(java.time.OffsetDateTime)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withRootCauseAttributionTime(OffsetDateTime rootCauseAttributionTime)" + name: "withRootCauseAttributionTime(OffsetDateTime rootCauseAttributionTime)" + nameWithType: "AvailabilityStatusProperties.withRootCauseAttributionTime(OffsetDateTime rootCauseAttributionTime)" + summary: "Set the rootCauseAttributionTime property: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received." + parameters: + - description: "the rootCauseAttributionTime value to set." + name: "rootCauseAttributionTime" + type: "OffsetDateTime" + syntax: "public AvailabilityStatusProperties withRootCauseAttributionTime(OffsetDateTime rootCauseAttributionTime)" + desc: "Set the rootCauseAttributionTime property: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withServiceImpactingEvents(java.util.List)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withServiceImpactingEvents(List serviceImpactingEvents)" + name: "withServiceImpactingEvents(List serviceImpactingEvents)" + nameWithType: "AvailabilityStatusProperties.withServiceImpactingEvents(List serviceImpactingEvents)" + summary: "Set the serviceImpactingEvents property: Lists the service impacting events that may be affecting the health of the resource." + parameters: + - description: "the serviceImpactingEvents value to set." + name: "serviceImpactingEvents" + type: "List<>" + syntax: "public AvailabilityStatusProperties withServiceImpactingEvents(List serviceImpactingEvents)" + desc: "Set the serviceImpactingEvents property: Lists the service impacting events that may be affecting the health of the resource." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withSummary(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withSummary(String summary)" + name: "withSummary(String summary)" + nameWithType: "AvailabilityStatusProperties.withSummary(String summary)" + summary: "Set the summary property: Summary description of the availability status." + parameters: + - description: "the summary value to set." + name: "summary" + type: "String" + syntax: "public AvailabilityStatusProperties withSummary(String summary)" + desc: "Set the summary property: Summary description of the availability status." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withTitle(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties.withTitle(String title)" + name: "withTitle(String title)" + nameWithType: "AvailabilityStatusProperties.withTitle(String title)" + summary: "Set the title property: Title description of the availability status." + parameters: + - description: "the title value to set." + name: "title" + type: "String" + syntax: "public AvailabilityStatusProperties withTitle(String title)" + desc: "Set the title property: Title description of the availability status." + returns: + description: "the AvailabilityStatusProperties object itself." + type: "" +type: "class" +desc: "Properties of availability state." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.yml new file mode 100644 index 000000000000..d79c49c4dfef --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.yml @@ -0,0 +1,116 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved" +fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved" +name: "AvailabilityStatusPropertiesRecentlyResolved" +nameWithType: "AvailabilityStatusPropertiesRecentlyResolved" +summary: "An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **AvailabilityStatusPropertiesRecentlyResolved**" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.AvailabilityStatusPropertiesRecentlyResolved()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.AvailabilityStatusPropertiesRecentlyResolved()" + name: "AvailabilityStatusPropertiesRecentlyResolved()" + nameWithType: "AvailabilityStatusPropertiesRecentlyResolved.AvailabilityStatusPropertiesRecentlyResolved()" + summary: "Creates an instance of AvailabilityStatusPropertiesRecentlyResolved class." + syntax: "public AvailabilityStatusPropertiesRecentlyResolved()" + desc: "Creates an instance of AvailabilityStatusPropertiesRecentlyResolved class." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.resolvedTime()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.resolvedTime()" + name: "resolvedTime()" + nameWithType: "AvailabilityStatusPropertiesRecentlyResolved.resolvedTime()" + summary: "Get the resolvedTime property: Timestamp when the availabilityState changes to Available." + syntax: "public OffsetDateTime resolvedTime()" + desc: "Get the resolvedTime property: Timestamp when the availabilityState changes to Available." + returns: + description: "the resolvedTime value." + type: "OffsetDateTime" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.unavailableOccuredTime()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.unavailableOccuredTime()" + name: "unavailableOccuredTime()" + nameWithType: "AvailabilityStatusPropertiesRecentlyResolved.unavailableOccuredTime()" + summary: "Get the unavailableOccuredTime property: Timestamp for when the availabilityState changed to Unavailable." + syntax: "public OffsetDateTime unavailableOccuredTime()" + desc: "Get the unavailableOccuredTime property: Timestamp for when the availabilityState changed to Unavailable." + returns: + description: "the unavailableOccuredTime value." + type: "OffsetDateTime" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.unavailableSummary()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.unavailableSummary()" + name: "unavailableSummary()" + nameWithType: "AvailabilityStatusPropertiesRecentlyResolved.unavailableSummary()" + summary: "Get the unavailableSummary property: Brief description of cause of the resource becoming unavailable." + syntax: "public String unavailableSummary()" + desc: "Get the unavailableSummary property: Brief description of cause of the resource becoming unavailable." + returns: + description: "the unavailableSummary value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.validate()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.validate()" + name: "validate()" + nameWithType: "AvailabilityStatusPropertiesRecentlyResolved.validate()" + summary: "Validates the instance." + syntax: "public void validate()" + desc: "Validates the instance." +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.withResolvedTime(java.time.OffsetDateTime)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.withResolvedTime(OffsetDateTime resolvedTime)" + name: "withResolvedTime(OffsetDateTime resolvedTime)" + nameWithType: "AvailabilityStatusPropertiesRecentlyResolved.withResolvedTime(OffsetDateTime resolvedTime)" + summary: "Set the resolvedTime property: Timestamp when the availabilityState changes to Available." + parameters: + - description: "the resolvedTime value to set." + name: "resolvedTime" + type: "OffsetDateTime" + syntax: "public AvailabilityStatusPropertiesRecentlyResolved withResolvedTime(OffsetDateTime resolvedTime)" + desc: "Set the resolvedTime property: Timestamp when the availabilityState changes to Available." + returns: + description: "the AvailabilityStatusPropertiesRecentlyResolved object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.withUnavailableOccuredTime(java.time.OffsetDateTime)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.withUnavailableOccuredTime(OffsetDateTime unavailableOccuredTime)" + name: "withUnavailableOccuredTime(OffsetDateTime unavailableOccuredTime)" + nameWithType: "AvailabilityStatusPropertiesRecentlyResolved.withUnavailableOccuredTime(OffsetDateTime unavailableOccuredTime)" + summary: "Set the unavailableOccuredTime property: Timestamp for when the availabilityState changed to Unavailable." + parameters: + - description: "the unavailableOccuredTime value to set." + name: "unavailableOccuredTime" + type: "OffsetDateTime" + syntax: "public AvailabilityStatusPropertiesRecentlyResolved withUnavailableOccuredTime(OffsetDateTime unavailableOccuredTime)" + desc: "Set the unavailableOccuredTime property: Timestamp for when the availabilityState changed to Unavailable." + returns: + description: "the AvailabilityStatusPropertiesRecentlyResolved object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.withUnavailableSummary(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved.withUnavailableSummary(String unavailableSummary)" + name: "withUnavailableSummary(String unavailableSummary)" + nameWithType: "AvailabilityStatusPropertiesRecentlyResolved.withUnavailableSummary(String unavailableSummary)" + summary: "Set the unavailableSummary property: Brief description of cause of the resource becoming unavailable." + parameters: + - description: "the unavailableSummary value to set." + name: "unavailableSummary" + type: "String" + syntax: "public AvailabilityStatusPropertiesRecentlyResolved withUnavailableSummary(String unavailableSummary)" + desc: "Set the unavailableSummary property: Brief description of cause of the resource becoming unavailable." + returns: + description: "the AvailabilityStatusPropertiesRecentlyResolved object itself." + type: "" +type: "class" +desc: "An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.yml new file mode 100644 index 000000000000..1389a1e89bfc --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.yml @@ -0,0 +1,170 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses" +fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses" +name: "AvailabilityStatuses" +nameWithType: "AvailabilityStatuses" +summary: "Resource collection API of AvailabilityStatuses." +syntax: "public interface **AvailabilityStatuses**" +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.getByResource(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.getByResource(String resourceUri)" + name: "getByResource(String resourceUri)" + nameWithType: "AvailabilityStatuses.getByResource(String resourceUri)" + summary: "Gets current availability status for a single resource." + modifiers: + - "abstract" + parameters: + - description: "The fully qualified ID of the resource, including the resource name and resource type.\n Currently the API support not nested and one nesting level resource types :\n /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}\n and\n /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}." + name: "resourceUri" + type: "String" + syntax: "public abstract AvailabilityStatus getByResource(String resourceUri)" + desc: "Gets current availability status for a single resource." + returns: + description: "current availability status for a single resource." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.getByResourceWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.getByResourceWithResponse(String resourceUri, String filter, String expand, Context context)" + name: "getByResourceWithResponse(String resourceUri, String filter, String expand, Context context)" + nameWithType: "AvailabilityStatuses.getByResourceWithResponse(String resourceUri, String filter, String expand, Context context)" + summary: "Gets current availability status for a single resource." + modifiers: + - "abstract" + parameters: + - description: "The fully qualified ID of the resource, including the resource name and resource type.\n Currently the API support not nested and one nesting level resource types :\n /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}\n and\n /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}." + name: "resourceUri" + type: "String" + - description: "The filter to apply on the operation. For more information please see\n https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN." + name: "filter" + type: "String" + - description: "Setting $expand=recommendedactions in url query expands the recommendedactions in the response." + name: "expand" + type: "String" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public abstract Response getByResourceWithResponse(String resourceUri, String filter, String expand, Context context)" + desc: "Gets current availability status for a single resource." + returns: + description: "current availability status for a single resource along with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.list(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.list(String resourceUri)" + name: "list(String resourceUri)" + nameWithType: "AvailabilityStatuses.list(String resourceUri)" + summary: "Lists all historical availability transitions and impacting events for a single resource." + modifiers: + - "abstract" + parameters: + - description: "The fully qualified ID of the resource, including the resource name and resource type.\n Currently the API support not nested and one nesting level resource types :\n /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}\n and\n /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}." + name: "resourceUri" + type: "String" + syntax: "public abstract PagedIterable list(String resourceUri)" + desc: "Lists all historical availability transitions and impacting events for a single resource." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.list(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.list(String resourceUri, String filter, String expand, Context context)" + name: "list(String resourceUri, String filter, String expand, Context context)" + nameWithType: "AvailabilityStatuses.list(String resourceUri, String filter, String expand, Context context)" + summary: "Lists all historical availability transitions and impacting events for a single resource." + modifiers: + - "abstract" + parameters: + - description: "The fully qualified ID of the resource, including the resource name and resource type.\n Currently the API support not nested and one nesting level resource types :\n /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}\n and\n /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}." + name: "resourceUri" + type: "String" + - description: "The filter to apply on the operation. For more information please see\n https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN." + name: "filter" + type: "String" + - description: "Setting $expand=recommendedactions in url query expands the recommendedactions in the response." + name: "expand" + type: "String" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public abstract PagedIterable list(String resourceUri, String filter, String expand, Context context)" + desc: "Lists all historical availability transitions and impacting events for a single resource." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.listByResourceGroup(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.listByResourceGroup(String resourceGroupName)" + name: "listByResourceGroup(String resourceGroupName)" + nameWithType: "AvailabilityStatuses.listByResourceGroup(String resourceGroupName)" + summary: "Lists the current availability status for all the resources in the resource group." + modifiers: + - "abstract" + parameters: + - description: "The name of the resource group." + name: "resourceGroupName" + type: "String" + syntax: "public abstract PagedIterable listByResourceGroup(String resourceGroupName)" + desc: "Lists the current availability status for all the resources in the resource group." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.listByResourceGroup(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.listByResourceGroup(String resourceGroupName, String filter, String expand, Context context)" + name: "listByResourceGroup(String resourceGroupName, String filter, String expand, Context context)" + nameWithType: "AvailabilityStatuses.listByResourceGroup(String resourceGroupName, String filter, String expand, Context context)" + summary: "Lists the current availability status for all the resources in the resource group." + modifiers: + - "abstract" + parameters: + - description: "The name of the resource group." + name: "resourceGroupName" + type: "String" + - description: "The filter to apply on the operation. For more information please see\n https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN." + name: "filter" + type: "String" + - description: "Setting $expand=recommendedactions in url query expands the recommendedactions in the response." + name: "expand" + type: "String" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public abstract PagedIterable listByResourceGroup(String resourceGroupName, String filter, String expand, Context context)" + desc: "Lists the current availability status for all the resources in the resource group." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.listBySubscriptionId()" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.listBySubscriptionId()" + name: "listBySubscriptionId()" + nameWithType: "AvailabilityStatuses.listBySubscriptionId()" + summary: "Lists the current availability status for all the resources in the subscription." + modifiers: + - "abstract" + syntax: "public abstract PagedIterable listBySubscriptionId()" + desc: "Lists the current availability status for all the resources in the subscription." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +- uid: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.listBySubscriptionId(java.lang.String,java.lang.String,com.azure.core.util.Context)" + fullName: "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses.listBySubscriptionId(String filter, String expand, Context context)" + name: "listBySubscriptionId(String filter, String expand, Context context)" + nameWithType: "AvailabilityStatuses.listBySubscriptionId(String filter, String expand, Context context)" + summary: "Lists the current availability status for all the resources in the subscription." + modifiers: + - "abstract" + parameters: + - description: "The filter to apply on the operation. For more information please see\n https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN." + name: "filter" + type: "String" + - description: "Setting $expand=recommendedactions in url query expands the recommendedactions in the response." + name: "expand" + type: "String" + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public abstract PagedIterable listBySubscriptionId(String filter, String expand, Context context)" + desc: "Lists the current availability status for all the resources in the subscription." + returns: + description: "the List availabilityStatus operation response as paginated response with ." + type: "<>" +type: "interface" +desc: "Resource collection API of AvailabilityStatuses." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.Operation.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.Operation.yml new file mode 100644 index 000000000000..e8209ded00ad --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.Operation.yml @@ -0,0 +1,92 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.Operation" +fullName: "com.azure.resourcemanager.resourcehealth.models.Operation" +name: "Operation" +nameWithType: "Operation" +summary: "Operation available in the resourcehealth resource provider." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **Operation**" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.models.Operation.Operation()" + fullName: "com.azure.resourcemanager.resourcehealth.models.Operation.Operation()" + name: "Operation()" + nameWithType: "Operation.Operation()" + summary: "Creates an instance of Operation class." + syntax: "public Operation()" + desc: "Creates an instance of Operation class." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.Operation.display()" + fullName: "com.azure.resourcemanager.resourcehealth.models.Operation.display()" + name: "display()" + nameWithType: "Operation.display()" + summary: "Get the display property: Properties of the operation." + syntax: "public OperationDisplay display()" + desc: "Get the display property: Properties of the operation." + returns: + description: "the display value." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.Operation.name()" + fullName: "com.azure.resourcemanager.resourcehealth.models.Operation.name()" + name: "name()" + nameWithType: "Operation.name()" + summary: "Get the name property: Name of the operation." + syntax: "public String name()" + desc: "Get the name property: Name of the operation." + returns: + description: "the name value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.Operation.validate()" + fullName: "com.azure.resourcemanager.resourcehealth.models.Operation.validate()" + name: "validate()" + nameWithType: "Operation.validate()" + summary: "Validates the instance." + syntax: "public void validate()" + desc: "Validates the instance." +- uid: "com.azure.resourcemanager.resourcehealth.models.Operation.withDisplay(com.azure.resourcemanager.resourcehealth.models.OperationDisplay)" + fullName: "com.azure.resourcemanager.resourcehealth.models.Operation.withDisplay(OperationDisplay display)" + name: "withDisplay(OperationDisplay display)" + nameWithType: "Operation.withDisplay(OperationDisplay display)" + summary: "Set the display property: Properties of the operation." + parameters: + - description: "the display value to set." + name: "display" + type: "" + syntax: "public Operation withDisplay(OperationDisplay display)" + desc: "Set the display property: Properties of the operation." + returns: + description: "the Operation object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.Operation.withName(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.Operation.withName(String name)" + name: "withName(String name)" + nameWithType: "Operation.withName(String name)" + summary: "Set the name property: Name of the operation." + parameters: + - description: "the name value to set." + name: "name" + type: "String" + syntax: "public Operation withName(String name)" + desc: "Set the name property: Name of the operation." + returns: + description: "the Operation object itself." + type: "" +type: "class" +desc: "Operation available in the resourcehealth resource provider." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.OperationDisplay.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.OperationDisplay.yml new file mode 100644 index 000000000000..be8bb5a2f685 --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.OperationDisplay.yml @@ -0,0 +1,140 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay" +fullName: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay" +name: "OperationDisplay" +nameWithType: "OperationDisplay" +summary: "Properties of the operation." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **OperationDisplay**" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.OperationDisplay()" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.OperationDisplay()" + name: "OperationDisplay()" + nameWithType: "OperationDisplay.OperationDisplay()" + summary: "Creates an instance of OperationDisplay class." + syntax: "public OperationDisplay()" + desc: "Creates an instance of OperationDisplay class." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.description()" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.description()" + name: "description()" + nameWithType: "OperationDisplay.description()" + summary: "Get the description property: Description of the operation." + syntax: "public String description()" + desc: "Get the description property: Description of the operation." + returns: + description: "the description value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.operation()" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.operation()" + name: "operation()" + nameWithType: "OperationDisplay.operation()" + summary: "Get the operation property: Operation name." + syntax: "public String operation()" + desc: "Get the operation property: Operation name." + returns: + description: "the operation value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.provider()" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.provider()" + name: "provider()" + nameWithType: "OperationDisplay.provider()" + summary: "Get the provider property: Provider name." + syntax: "public String provider()" + desc: "Get the provider property: Provider name." + returns: + description: "the provider value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.resource()" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.resource()" + name: "resource()" + nameWithType: "OperationDisplay.resource()" + summary: "Get the resource property: Resource name." + syntax: "public String resource()" + desc: "Get the resource property: Resource name." + returns: + description: "the resource value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.validate()" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.validate()" + name: "validate()" + nameWithType: "OperationDisplay.validate()" + summary: "Validates the instance." + syntax: "public void validate()" + desc: "Validates the instance." +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.withDescription(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.withDescription(String description)" + name: "withDescription(String description)" + nameWithType: "OperationDisplay.withDescription(String description)" + summary: "Set the description property: Description of the operation." + parameters: + - description: "the description value to set." + name: "description" + type: "String" + syntax: "public OperationDisplay withDescription(String description)" + desc: "Set the description property: Description of the operation." + returns: + description: "the OperationDisplay object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.withOperation(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.withOperation(String operation)" + name: "withOperation(String operation)" + nameWithType: "OperationDisplay.withOperation(String operation)" + summary: "Set the operation property: Operation name." + parameters: + - description: "the operation value to set." + name: "operation" + type: "String" + syntax: "public OperationDisplay withOperation(String operation)" + desc: "Set the operation property: Operation name." + returns: + description: "the OperationDisplay object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.withProvider(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.withProvider(String provider)" + name: "withProvider(String provider)" + nameWithType: "OperationDisplay.withProvider(String provider)" + summary: "Set the provider property: Provider name." + parameters: + - description: "the provider value to set." + name: "provider" + type: "String" + syntax: "public OperationDisplay withProvider(String provider)" + desc: "Set the provider property: Provider name." + returns: + description: "the OperationDisplay object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.withResource(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationDisplay.withResource(String resource)" + name: "withResource(String resource)" + nameWithType: "OperationDisplay.withResource(String resource)" + summary: "Set the resource property: Resource name." + parameters: + - description: "the resource value to set." + name: "resource" + type: "String" + syntax: "public OperationDisplay withResource(String resource)" + desc: "Set the resource property: Resource name." + returns: + description: "the OperationDisplay object itself." + type: "" +type: "class" +desc: "Properties of the operation." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.OperationListResult.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.OperationListResult.yml new file mode 100644 index 000000000000..99934efe1ac6 --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.OperationListResult.yml @@ -0,0 +1,37 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.OperationListResult" +fullName: "com.azure.resourcemanager.resourcehealth.models.OperationListResult" +name: "OperationListResult" +nameWithType: "OperationListResult" +summary: "An immutable client-side representation of OperationListResult." +syntax: "public interface **OperationListResult**" +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationListResult.innerModel()" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationListResult.innerModel()" + name: "innerModel()" + nameWithType: "OperationListResult.innerModel()" + summary: "Gets the inner com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner object." + modifiers: + - "abstract" + syntax: "public abstract OperationListResultInner innerModel()" + desc: "Gets the inner com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner object." + returns: + description: "the inner object." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.OperationListResult.value()" + fullName: "com.azure.resourcemanager.resourcehealth.models.OperationListResult.value()" + name: "value()" + nameWithType: "OperationListResult.value()" + summary: "Gets the value property: List of operations available in the resourcehealth resource provider." + modifiers: + - "abstract" + syntax: "public abstract List value()" + desc: "Gets the value property: List of operations available in the resourcehealth resource provider." + returns: + description: "the value value." + type: "List<>" +type: "interface" +desc: "An immutable client-side representation of OperationListResult." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.Operations.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.Operations.yml new file mode 100644 index 000000000000..eec13caf28ca --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.Operations.yml @@ -0,0 +1,41 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.Operations" +fullName: "com.azure.resourcemanager.resourcehealth.models.Operations" +name: "Operations" +nameWithType: "Operations" +summary: "Resource collection API of Operations." +syntax: "public interface **Operations**" +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.Operations.list()" + fullName: "com.azure.resourcemanager.resourcehealth.models.Operations.list()" + name: "list()" + nameWithType: "Operations.list()" + summary: "Lists available operations for the resourcehealth resource provider." + modifiers: + - "abstract" + syntax: "public abstract OperationListResult list()" + desc: "Lists available operations for the resourcehealth resource provider." + returns: + description: "lists the operations response." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.Operations.listWithResponse(com.azure.core.util.Context)" + fullName: "com.azure.resourcemanager.resourcehealth.models.Operations.listWithResponse(Context context)" + name: "listWithResponse(Context context)" + nameWithType: "Operations.listWithResponse(Context context)" + summary: "Lists available operations for the resourcehealth resource provider." + modifiers: + - "abstract" + parameters: + - description: "The context to associate with this operation." + name: "context" + type: "" + syntax: "public abstract Response listWithResponse(Context context)" + desc: "Lists available operations for the resourcehealth resource provider." + returns: + description: "lists the operations response along with ." + type: "<>" +type: "interface" +desc: "Resource collection API of Operations." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.yml new file mode 100644 index 000000000000..aad5436293c8 --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.yml @@ -0,0 +1,93 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes" +fullName: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes" +name: "ReasonChronicityTypes" +nameWithType: "ReasonChronicityTypes" +summary: "Chronicity of the availability transition." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **ReasonChronicityTypes**
extends <>" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.ReasonChronicityTypes()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.ReasonChronicityTypes()" + name: "ReasonChronicityTypes()" + nameWithType: "ReasonChronicityTypes.ReasonChronicityTypes()" + syntax: "public ReasonChronicityTypes()" +fields: +- uid: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.PERSISTENT" + fullName: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.PERSISTENT" + name: "PERSISTENT" + nameWithType: "ReasonChronicityTypes.PERSISTENT" + summary: "Static value Persistent for ReasonChronicityTypes." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final ReasonChronicityTypes PERSISTENT" + desc: "Static value Persistent for ReasonChronicityTypes." +- uid: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.TRANSIENT" + fullName: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.TRANSIENT" + name: "TRANSIENT" + nameWithType: "ReasonChronicityTypes.TRANSIENT" + summary: "Static value Transient for ReasonChronicityTypes." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final ReasonChronicityTypes TRANSIENT" + desc: "Static value Transient for ReasonChronicityTypes." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.fromString(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.fromString(String name)" + name: "fromString(String name)" + nameWithType: "ReasonChronicityTypes.fromString(String name)" + summary: "Creates or finds a ReasonChronicityTypes from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static ReasonChronicityTypes fromString(String name)" + desc: "Creates or finds a ReasonChronicityTypes from its string representation." + returns: + description: "the corresponding ReasonChronicityTypes." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.values()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes.values()" + name: "values()" + nameWithType: "ReasonChronicityTypes.values()" + summary: "Gets known ReasonChronicityTypes values." + modifiers: + - "static" + syntax: "public static Collection values()" + desc: "Gets known ReasonChronicityTypes values." + returns: + description: "known ReasonChronicityTypes values." + type: "Collection<>" +type: "class" +desc: "Chronicity of the availability transition." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.RecommendedAction.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.RecommendedAction.yml new file mode 100644 index 000000000000..9e29a7be2ba7 --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.RecommendedAction.yml @@ -0,0 +1,116 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction" +fullName: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction" +name: "RecommendedAction" +nameWithType: "RecommendedAction" +summary: "Lists actions the user can take based on the current availabilityState of the resource." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **RecommendedAction**" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.RecommendedAction()" + fullName: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.RecommendedAction()" + name: "RecommendedAction()" + nameWithType: "RecommendedAction.RecommendedAction()" + summary: "Creates an instance of RecommendedAction class." + syntax: "public RecommendedAction()" + desc: "Creates an instance of RecommendedAction class." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.action()" + fullName: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.action()" + name: "action()" + nameWithType: "RecommendedAction.action()" + summary: "Get the action property: Recommended action." + syntax: "public String action()" + desc: "Get the action property: Recommended action." + returns: + description: "the action value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.actionUrl()" + fullName: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.actionUrl()" + name: "actionUrl()" + nameWithType: "RecommendedAction.actionUrl()" + summary: "Get the actionUrl property: Link to the action." + syntax: "public String actionUrl()" + desc: "Get the actionUrl property: Link to the action." + returns: + description: "the actionUrl value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.actionUrlText()" + fullName: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.actionUrlText()" + name: "actionUrlText()" + nameWithType: "RecommendedAction.actionUrlText()" + summary: "Get the actionUrlText property: Substring of action, it describes which text should host the action url." + syntax: "public String actionUrlText()" + desc: "Get the actionUrlText property: Substring of action, it describes which text should host the action url." + returns: + description: "the actionUrlText value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.validate()" + fullName: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.validate()" + name: "validate()" + nameWithType: "RecommendedAction.validate()" + summary: "Validates the instance." + syntax: "public void validate()" + desc: "Validates the instance." +- uid: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.withAction(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.withAction(String action)" + name: "withAction(String action)" + nameWithType: "RecommendedAction.withAction(String action)" + summary: "Set the action property: Recommended action." + parameters: + - description: "the action value to set." + name: "action" + type: "String" + syntax: "public RecommendedAction withAction(String action)" + desc: "Set the action property: Recommended action." + returns: + description: "the RecommendedAction object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.withActionUrl(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.withActionUrl(String actionUrl)" + name: "withActionUrl(String actionUrl)" + nameWithType: "RecommendedAction.withActionUrl(String actionUrl)" + summary: "Set the actionUrl property: Link to the action." + parameters: + - description: "the actionUrl value to set." + name: "actionUrl" + type: "String" + syntax: "public RecommendedAction withActionUrl(String actionUrl)" + desc: "Set the actionUrl property: Link to the action." + returns: + description: "the RecommendedAction object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.withActionUrlText(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.RecommendedAction.withActionUrlText(String actionUrlText)" + name: "withActionUrlText(String actionUrlText)" + nameWithType: "RecommendedAction.withActionUrlText(String actionUrlText)" + summary: "Set the actionUrlText property: Substring of action, it describes which text should host the action url." + parameters: + - description: "the actionUrlText value to set." + name: "actionUrlText" + type: "String" + syntax: "public RecommendedAction withActionUrlText(String actionUrlText)" + desc: "Set the actionUrlText property: Substring of action, it describes which text should host the action url." + returns: + description: "the RecommendedAction object itself." + type: "" +type: "class" +desc: "Lists actions the user can take based on the current availabilityState of the resource." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.yml new file mode 100644 index 000000000000..2fcc9b56423a --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.yml @@ -0,0 +1,164 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent" +fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent" +name: "ServiceImpactingEvent" +nameWithType: "ServiceImpactingEvent" +summary: "Lists the service impacting events that may be affecting the health of the resource." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **ServiceImpactingEvent**" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.ServiceImpactingEvent()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.ServiceImpactingEvent()" + name: "ServiceImpactingEvent()" + nameWithType: "ServiceImpactingEvent.ServiceImpactingEvent()" + summary: "Creates an instance of ServiceImpactingEvent class." + syntax: "public ServiceImpactingEvent()" + desc: "Creates an instance of ServiceImpactingEvent class." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.correlationId()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.correlationId()" + name: "correlationId()" + nameWithType: "ServiceImpactingEvent.correlationId()" + summary: "Get the correlationId property: Correlation id for the event." + syntax: "public String correlationId()" + desc: "Get the correlationId property: Correlation id for the event." + returns: + description: "the correlationId value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.eventStartTime()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.eventStartTime()" + name: "eventStartTime()" + nameWithType: "ServiceImpactingEvent.eventStartTime()" + summary: "Get the eventStartTime property: Timestamp for when the event started." + syntax: "public OffsetDateTime eventStartTime()" + desc: "Get the eventStartTime property: Timestamp for when the event started." + returns: + description: "the eventStartTime value." + type: "OffsetDateTime" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.eventStatusLastModifiedTime()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.eventStatusLastModifiedTime()" + name: "eventStatusLastModifiedTime()" + nameWithType: "ServiceImpactingEvent.eventStatusLastModifiedTime()" + summary: "Get the eventStatusLastModifiedTime property: Timestamp for when event was submitted/detected." + syntax: "public OffsetDateTime eventStatusLastModifiedTime()" + desc: "Get the eventStatusLastModifiedTime property: Timestamp for when event was submitted/detected." + returns: + description: "the eventStatusLastModifiedTime value." + type: "OffsetDateTime" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.incidentProperties()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.incidentProperties()" + name: "incidentProperties()" + nameWithType: "ServiceImpactingEvent.incidentProperties()" + summary: "Get the incidentProperties property: Properties of the service impacting event." + syntax: "public ServiceImpactingEventIncidentProperties incidentProperties()" + desc: "Get the incidentProperties property: Properties of the service impacting event." + returns: + description: "the incidentProperties value." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.status()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.status()" + name: "status()" + nameWithType: "ServiceImpactingEvent.status()" + summary: "Get the status property: Status of the service impacting event." + syntax: "public ServiceImpactingEventStatus status()" + desc: "Get the status property: Status of the service impacting event." + returns: + description: "the status value." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.validate()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.validate()" + name: "validate()" + nameWithType: "ServiceImpactingEvent.validate()" + summary: "Validates the instance." + syntax: "public void validate()" + desc: "Validates the instance." +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.withCorrelationId(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.withCorrelationId(String correlationId)" + name: "withCorrelationId(String correlationId)" + nameWithType: "ServiceImpactingEvent.withCorrelationId(String correlationId)" + summary: "Set the correlationId property: Correlation id for the event." + parameters: + - description: "the correlationId value to set." + name: "correlationId" + type: "String" + syntax: "public ServiceImpactingEvent withCorrelationId(String correlationId)" + desc: "Set the correlationId property: Correlation id for the event." + returns: + description: "the ServiceImpactingEvent object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.withEventStartTime(java.time.OffsetDateTime)" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.withEventStartTime(OffsetDateTime eventStartTime)" + name: "withEventStartTime(OffsetDateTime eventStartTime)" + nameWithType: "ServiceImpactingEvent.withEventStartTime(OffsetDateTime eventStartTime)" + summary: "Set the eventStartTime property: Timestamp for when the event started." + parameters: + - description: "the eventStartTime value to set." + name: "eventStartTime" + type: "OffsetDateTime" + syntax: "public ServiceImpactingEvent withEventStartTime(OffsetDateTime eventStartTime)" + desc: "Set the eventStartTime property: Timestamp for when the event started." + returns: + description: "the ServiceImpactingEvent object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.withEventStatusLastModifiedTime(java.time.OffsetDateTime)" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.withEventStatusLastModifiedTime(OffsetDateTime eventStatusLastModifiedTime)" + name: "withEventStatusLastModifiedTime(OffsetDateTime eventStatusLastModifiedTime)" + nameWithType: "ServiceImpactingEvent.withEventStatusLastModifiedTime(OffsetDateTime eventStatusLastModifiedTime)" + summary: "Set the eventStatusLastModifiedTime property: Timestamp for when event was submitted/detected." + parameters: + - description: "the eventStatusLastModifiedTime value to set." + name: "eventStatusLastModifiedTime" + type: "OffsetDateTime" + syntax: "public ServiceImpactingEvent withEventStatusLastModifiedTime(OffsetDateTime eventStatusLastModifiedTime)" + desc: "Set the eventStatusLastModifiedTime property: Timestamp for when event was submitted/detected." + returns: + description: "the ServiceImpactingEvent object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.withIncidentProperties(com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties)" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.withIncidentProperties(ServiceImpactingEventIncidentProperties incidentProperties)" + name: "withIncidentProperties(ServiceImpactingEventIncidentProperties incidentProperties)" + nameWithType: "ServiceImpactingEvent.withIncidentProperties(ServiceImpactingEventIncidentProperties incidentProperties)" + summary: "Set the incidentProperties property: Properties of the service impacting event." + parameters: + - description: "the incidentProperties value to set." + name: "incidentProperties" + type: "" + syntax: "public ServiceImpactingEvent withIncidentProperties(ServiceImpactingEventIncidentProperties incidentProperties)" + desc: "Set the incidentProperties property: Properties of the service impacting event." + returns: + description: "the ServiceImpactingEvent object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.withStatus(com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus)" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent.withStatus(ServiceImpactingEventStatus status)" + name: "withStatus(ServiceImpactingEventStatus status)" + nameWithType: "ServiceImpactingEvent.withStatus(ServiceImpactingEventStatus status)" + summary: "Set the status property: Status of the service impacting event." + parameters: + - description: "the status value to set." + name: "status" + type: "" + syntax: "public ServiceImpactingEvent withStatus(ServiceImpactingEventStatus status)" + desc: "Set the status property: Status of the service impacting event." + returns: + description: "the ServiceImpactingEvent object itself." + type: "" +type: "class" +desc: "Lists the service impacting events that may be affecting the health of the resource." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.yml new file mode 100644 index 000000000000..66e38125cf5f --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.yml @@ -0,0 +1,140 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties" +fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties" +name: "ServiceImpactingEventIncidentProperties" +nameWithType: "ServiceImpactingEventIncidentProperties" +summary: "Properties of the service impacting event." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **ServiceImpactingEventIncidentProperties**" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.ServiceImpactingEventIncidentProperties()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.ServiceImpactingEventIncidentProperties()" + name: "ServiceImpactingEventIncidentProperties()" + nameWithType: "ServiceImpactingEventIncidentProperties.ServiceImpactingEventIncidentProperties()" + summary: "Creates an instance of ServiceImpactingEventIncidentProperties class." + syntax: "public ServiceImpactingEventIncidentProperties()" + desc: "Creates an instance of ServiceImpactingEventIncidentProperties class." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.incidentType()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.incidentType()" + name: "incidentType()" + nameWithType: "ServiceImpactingEventIncidentProperties.incidentType()" + summary: "Get the incidentType property: Type of Event." + syntax: "public String incidentType()" + desc: "Get the incidentType property: Type of Event." + returns: + description: "the incidentType value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.region()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.region()" + name: "region()" + nameWithType: "ServiceImpactingEventIncidentProperties.region()" + summary: "Get the region property: Region impacted by the event." + syntax: "public String region()" + desc: "Get the region property: Region impacted by the event." + returns: + description: "the region value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.service()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.service()" + name: "service()" + nameWithType: "ServiceImpactingEventIncidentProperties.service()" + summary: "Get the service property: Service impacted by the event." + syntax: "public String service()" + desc: "Get the service property: Service impacted by the event." + returns: + description: "the service value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.title()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.title()" + name: "title()" + nameWithType: "ServiceImpactingEventIncidentProperties.title()" + summary: "Get the title property: Title of the incident." + syntax: "public String title()" + desc: "Get the title property: Title of the incident." + returns: + description: "the title value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.validate()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.validate()" + name: "validate()" + nameWithType: "ServiceImpactingEventIncidentProperties.validate()" + summary: "Validates the instance." + syntax: "public void validate()" + desc: "Validates the instance." +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.withIncidentType(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.withIncidentType(String incidentType)" + name: "withIncidentType(String incidentType)" + nameWithType: "ServiceImpactingEventIncidentProperties.withIncidentType(String incidentType)" + summary: "Set the incidentType property: Type of Event." + parameters: + - description: "the incidentType value to set." + name: "incidentType" + type: "String" + syntax: "public ServiceImpactingEventIncidentProperties withIncidentType(String incidentType)" + desc: "Set the incidentType property: Type of Event." + returns: + description: "the ServiceImpactingEventIncidentProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.withRegion(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.withRegion(String region)" + name: "withRegion(String region)" + nameWithType: "ServiceImpactingEventIncidentProperties.withRegion(String region)" + summary: "Set the region property: Region impacted by the event." + parameters: + - description: "the region value to set." + name: "region" + type: "String" + syntax: "public ServiceImpactingEventIncidentProperties withRegion(String region)" + desc: "Set the region property: Region impacted by the event." + returns: + description: "the ServiceImpactingEventIncidentProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.withService(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.withService(String service)" + name: "withService(String service)" + nameWithType: "ServiceImpactingEventIncidentProperties.withService(String service)" + summary: "Set the service property: Service impacted by the event." + parameters: + - description: "the service value to set." + name: "service" + type: "String" + syntax: "public ServiceImpactingEventIncidentProperties withService(String service)" + desc: "Set the service property: Service impacted by the event." + returns: + description: "the ServiceImpactingEventIncidentProperties object itself." + type: "" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.withTitle(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties.withTitle(String title)" + name: "withTitle(String title)" + nameWithType: "ServiceImpactingEventIncidentProperties.withTitle(String title)" + summary: "Set the title property: Title of the incident." + parameters: + - description: "the title value to set." + name: "title" + type: "String" + syntax: "public ServiceImpactingEventIncidentProperties withTitle(String title)" + desc: "Set the title property: Title of the incident." + returns: + description: "the ServiceImpactingEventIncidentProperties object itself." + type: "" +type: "class" +desc: "Properties of the service impacting event." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.yml new file mode 100644 index 000000000000..e32b7dd61018 --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.yml @@ -0,0 +1,68 @@ +### YamlMime:JavaType +uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus" +fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus" +name: "ServiceImpactingEventStatus" +nameWithType: "ServiceImpactingEventStatus" +summary: "Status of the service impacting event." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **ServiceImpactingEventStatus**" +constructors: +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.ServiceImpactingEventStatus()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.ServiceImpactingEventStatus()" + name: "ServiceImpactingEventStatus()" + nameWithType: "ServiceImpactingEventStatus.ServiceImpactingEventStatus()" + summary: "Creates an instance of ServiceImpactingEventStatus class." + syntax: "public ServiceImpactingEventStatus()" + desc: "Creates an instance of ServiceImpactingEventStatus class." +methods: +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.validate()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.validate()" + name: "validate()" + nameWithType: "ServiceImpactingEventStatus.validate()" + summary: "Validates the instance." + syntax: "public void validate()" + desc: "Validates the instance." +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.value()" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.value()" + name: "value()" + nameWithType: "ServiceImpactingEventStatus.value()" + summary: "Get the value property: Current status of the event." + syntax: "public String value()" + desc: "Get the value property: Current status of the event." + returns: + description: "the value value." + type: "String" +- uid: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.withValue(java.lang.String)" + fullName: "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus.withValue(String value)" + name: "withValue(String value)" + nameWithType: "ServiceImpactingEventStatus.withValue(String value)" + summary: "Set the value property: Current status of the event." + parameters: + - description: "the value value to set." + name: "value" + type: "String" + syntax: "public ServiceImpactingEventStatus withValue(String value)" + desc: "Set the value property: Current status of the event." + returns: + description: "the ServiceImpactingEventStatus object itself." + type: "" +type: "class" +desc: "Status of the service impacting event." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.yml new file mode 100644 index 000000000000..c85a1a7bdeff --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.models.yml @@ -0,0 +1,26 @@ +### YamlMime:JavaPackage +uid: "com.azure.resourcemanager.resourcehealth.models" +fullName: "com.azure.resourcemanager.resourcehealth.models" +name: "com.azure.resourcemanager.resourcehealth.models" +summary: "Package containing the data models for MicrosoftResourceHealth." +classes: +- "com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues" +- "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult" +- "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties" +- "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved" +- "com.azure.resourcemanager.resourcehealth.models.Operation" +- "com.azure.resourcemanager.resourcehealth.models.OperationDisplay" +- "com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes" +- "com.azure.resourcemanager.resourcehealth.models.RecommendedAction" +- "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent" +- "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties" +- "com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus" +interfaces: +- "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus" +- "com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses" +- "com.azure.resourcemanager.resourcehealth.models.OperationListResult" +- "com.azure.resourcemanager.resourcehealth.models.Operations" +desc: "Package containing the data models for MicrosoftResourceHealth. The Resource Health Client." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth.models" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.yml b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.yml new file mode 100644 index 000000000000..231a81ffdce7 --- /dev/null +++ b/docs-ref-autogen/com.azure.resourcemanager.resourcehealth.yml @@ -0,0 +1,12 @@ +### YamlMime:JavaPackage +uid: "com.azure.resourcemanager.resourcehealth" +fullName: "com.azure.resourcemanager.resourcehealth" +name: "com.azure.resourcemanager.resourcehealth" +summary: "Package containing the classes for MicrosoftResourceHealth." +classes: +- "com.azure.resourcemanager.resourcehealth.ResourceHealthManager" +- "com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable" +desc: "Package containing the classes for MicrosoftResourceHealth. The Resource Health Client." +metadata: {} +package: "com.azure.resourcemanager.resourcehealth" +artifact: com.azure.resourcemanager:azure-resourcemanager-resourcehealth:1.0.0 diff --git a/docs-ref-autogen/toc.yml b/docs-ref-autogen/toc.yml index addc9c3996ab..431b838825ee 100644 --- a/docs-ref-autogen/toc.yml +++ b/docs-ref-autogen/toc.yml @@ -50031,6 +50031,62 @@ items: - uid: com.azure.identity.extensions.jdbc.postgresql.AzurePostgresqlAuthenticationPlugin name: AzurePostgresqlAuthenticationPlugin +- uid: com.azure.resourcemanager.resourcehealth.fluent + name: com.azure.resourcemanager.resourcehealth.fluent + items: + - uid: com.azure.resourcemanager.resourcehealth.fluent.AvailabilityStatusesClient + name: AvailabilityStatusesClient + - uid: com.azure.resourcemanager.resourcehealth.fluent.MicrosoftResourceHealth + name: MicrosoftResourceHealth + - uid: com.azure.resourcemanager.resourcehealth.fluent.OperationsClient + name: OperationsClient +- uid: com.azure.resourcemanager.resourcehealth.models + name: com.azure.resourcemanager.resourcehealth.models + items: + - uid: com.azure.resourcemanager.resourcehealth.models.AvailabilityStateValues + name: AvailabilityStateValues + - uid: com.azure.resourcemanager.resourcehealth.models.AvailabilityStatus + name: AvailabilityStatus + - uid: com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusListResult + name: AvailabilityStatusListResult + - uid: com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusProperties + name: AvailabilityStatusProperties + - uid: com.azure.resourcemanager.resourcehealth.models.AvailabilityStatusPropertiesRecentlyResolved + name: AvailabilityStatusPropertiesRecentlyResolved + - uid: com.azure.resourcemanager.resourcehealth.models.AvailabilityStatuses + name: AvailabilityStatuses + - uid: com.azure.resourcemanager.resourcehealth.models.Operation + name: Operation + - uid: com.azure.resourcemanager.resourcehealth.models.OperationDisplay + name: OperationDisplay + - uid: com.azure.resourcemanager.resourcehealth.models.OperationListResult + name: OperationListResult + - uid: com.azure.resourcemanager.resourcehealth.models.Operations + name: Operations + - uid: com.azure.resourcemanager.resourcehealth.models.ReasonChronicityTypes + name: ReasonChronicityTypes + - uid: com.azure.resourcemanager.resourcehealth.models.RecommendedAction + name: RecommendedAction + - uid: com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEvent + name: ServiceImpactingEvent + - uid: com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventIncidentProperties + name: ServiceImpactingEventIncidentProperties + - uid: com.azure.resourcemanager.resourcehealth.models.ServiceImpactingEventStatus + name: ServiceImpactingEventStatus +- uid: com.azure.resourcemanager.resourcehealth.fluent.models + name: com.azure.resourcemanager.resourcehealth.fluent.models + items: + - uid: com.azure.resourcemanager.resourcehealth.fluent.models.AvailabilityStatusInner + name: AvailabilityStatusInner + - uid: com.azure.resourcemanager.resourcehealth.fluent.models.OperationListResultInner + name: OperationListResultInner +- uid: com.azure.resourcemanager.resourcehealth + name: com.azure.resourcemanager.resourcehealth + items: + - uid: com.azure.resourcemanager.resourcehealth.ResourceHealthManager + name: ResourceHealthManager + - uid: com.azure.resourcemanager.resourcehealth.ResourceHealthManager.Configurable + name: ResourceHealthManager.Configurable - items: - name: ADALError uid: com.microsoft.aad.adal.ADALError diff --git a/docs-ref-mapping/reference-latest.yml b/docs-ref-mapping/reference-latest.yml index 12a5a8e4924c..201ea95c7cfa 100644 --- a/docs-ref-mapping/reference-latest.yml +++ b/docs-ref-mapping/reference-latest.yml @@ -1035,6 +1035,19 @@ - com.azure.resourcemanager.resourcegraph.fluent - com.azure.resourcemanager.resourcegraph.fluent.models - com.azure.resourcemanager.resourcegraph.models + - name: Resource Health + href: ~/docs-ref-services/latest/resource-health.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Resource Health + href: ~/docs-ref-services/latest/resourcemanager-resourcehealth-readme.md + children: + - com.azure.resourcemanager.resourcehealth + - com.azure.resourcemanager.resourcehealth.fluent + - com.azure.resourcemanager.resourcehealth.fluent.models + - com.azure.resourcemanager.resourcehealth.models - name: Resource Mover landingPageType: Service items: diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.yml index 4c91e19e6b2a..94da805f40a3 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.yml @@ -22,348 +22,323 @@ inheritedClassMethods: - "wait" syntax: "public final class **AnomalyDetectorAsyncClient**" methods: -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.deleteMultivariateModel(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.deleteMultivariateModel(UUID modelId)" - name: "deleteMultivariateModel(UUID modelId)" - nameWithType: "AnomalyDetectorAsyncClient.deleteMultivariateModel(UUID modelId)" - summary: "Delete an existing multivariate model according to the modelId." +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.deleteMultivariateModel(java.lang.String)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.deleteMultivariateModel(String modelId)" + name: "deleteMultivariateModel(String modelId)" + nameWithType: "AnomalyDetectorAsyncClient.deleteMultivariateModel(String modelId)" + summary: "Delete Multivariate Model" parameters: - description: "Model identifier." name: "modelId" - type: "UUID" - syntax: "public Mono deleteMultivariateModel(UUID modelId)" - desc: "Delete an existing multivariate model according to the modelId." - returns: - description: "the completion." - type: "Mono<Void>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.deleteMultivariateModelWithResponse(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.deleteMultivariateModelWithResponse(UUID modelId)" - name: "deleteMultivariateModelWithResponse(UUID modelId)" - nameWithType: "AnomalyDetectorAsyncClient.deleteMultivariateModelWithResponse(UUID modelId)" - summary: "Delete an existing multivariate model according to the modelId." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - syntax: "public Mono> deleteMultivariateModelWithResponse(UUID modelId)" - desc: "Delete an existing multivariate model according to the modelId." - returns: - description: "the completion." - type: "Mono<<Void>>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectAnomaly(java.util.UUID,com.azure.ai.anomalydetector.models.DetectionRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectAnomaly(UUID modelId, DetectionRequest body)" - name: "detectAnomaly(UUID modelId, DetectionRequest body)" - nameWithType: "AnomalyDetectorAsyncClient.detectAnomaly(UUID modelId, DetectionRequest body)" - summary: "Submit detection multivariate anomaly task with the trained model of modelId, the input schema should be the same with the training request." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - - description: "Detect anomaly request." - name: "body" - type: "" - syntax: "public Mono detectAnomaly(UUID modelId, DetectionRequest body)" - desc: "Submit detection multivariate anomaly task with the trained model of modelId, the input schema should be the same with the training request. Thus request will be complete asynchronously and will return a resultId for querying the detection result.The request should be a source link to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be as follows: the first column is timestamp and the second column is value." - returns: - description: "the completion." - type: "Mono<Void>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectAnomalyWithResponse(java.util.UUID,com.azure.ai.anomalydetector.models.DetectionRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectAnomalyWithResponse(UUID modelId, DetectionRequest body)" - name: "detectAnomalyWithResponse(UUID modelId, DetectionRequest body)" - nameWithType: "AnomalyDetectorAsyncClient.detectAnomalyWithResponse(UUID modelId, DetectionRequest body)" - summary: "Submit detection multivariate anomaly task with the trained model of modelId, the input schema should be the same with the training request." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - - description: "Detect anomaly request." - name: "body" - type: "" - syntax: "public Mono detectAnomalyWithResponse(UUID modelId, DetectionRequest body)" - desc: "Submit detection multivariate anomaly task with the trained model of modelId, the input schema should be the same with the training request. Thus request will be complete asynchronously and will return a resultId for querying the detection result.The request should be a source link to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be as follows: the first column is timestamp and the second column is value." - returns: - description: "the completion." - type: "Mono<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectChangePoint(com.azure.ai.anomalydetector.models.ChangePointDetectRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectChangePoint(ChangePointDetectRequest body)" - name: "detectChangePoint(ChangePointDetectRequest body)" - nameWithType: "AnomalyDetectorAsyncClient.detectChangePoint(ChangePointDetectRequest body)" - summary: "Evaluate change point score of every series point." - parameters: - - description: "Time series points and granularity is needed. Advanced model parameters can also be set in the\n request if needed." - name: "body" - type: "" - syntax: "public Mono detectChangePoint(ChangePointDetectRequest body)" - desc: "Evaluate change point score of every series point." - returns: - description: "the response of change point detection." - type: "Mono<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectChangePointWithResponse(com.azure.ai.anomalydetector.models.ChangePointDetectRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectChangePointWithResponse(ChangePointDetectRequest body)" - name: "detectChangePointWithResponse(ChangePointDetectRequest body)" - nameWithType: "AnomalyDetectorAsyncClient.detectChangePointWithResponse(ChangePointDetectRequest body)" - summary: "Evaluate change point score of every series point." - parameters: - - description: "Time series points and granularity is needed. Advanced model parameters can also be set in the\n request if needed." - name: "body" - type: "" - syntax: "public Mono> detectChangePointWithResponse(ChangePointDetectRequest body)" - desc: "Evaluate change point score of every series point." - returns: - description: "the response of change point detection." - type: "Mono<<>>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectEntireSeries(com.azure.ai.anomalydetector.models.DetectRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectEntireSeries(DetectRequest body)" - name: "detectEntireSeries(DetectRequest body)" - nameWithType: "AnomalyDetectorAsyncClient.detectEntireSeries(DetectRequest body)" - summary: "This operation generates a model with an entire series, each point is detected with the same model." - parameters: - - description: "Time series points and period if needed. Advanced model parameters can also be set in the request." - name: "body" - type: "" - syntax: "public Mono detectEntireSeries(DetectRequest body)" - desc: "This operation generates a model with an entire series, each point is detected with the same model. With this method, points before and after a certain point are used to determine whether it is an anomaly. The entire detection can give user an overall status of the time series." - returns: - description: "the response of entire anomaly detection." - type: "Mono<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectEntireSeriesWithResponse(com.azure.ai.anomalydetector.models.DetectRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectEntireSeriesWithResponse(DetectRequest body)" - name: "detectEntireSeriesWithResponse(DetectRequest body)" - nameWithType: "AnomalyDetectorAsyncClient.detectEntireSeriesWithResponse(DetectRequest body)" - summary: "This operation generates a model with an entire series, each point is detected with the same model." - parameters: - - description: "Time series points and period if needed. Advanced model parameters can also be set in the request." - name: "body" - type: "" - syntax: "public Mono> detectEntireSeriesWithResponse(DetectRequest body)" - desc: "This operation generates a model with an entire series, each point is detected with the same model. With this method, points before and after a certain point are used to determine whether it is an anomaly. The entire detection can give user an overall status of the time series." - returns: - description: "the response of entire anomaly detection." - type: "Mono<<>>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectLastPoint(com.azure.ai.anomalydetector.models.DetectRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectLastPoint(DetectRequest body)" - name: "detectLastPoint(DetectRequest body)" - nameWithType: "AnomalyDetectorAsyncClient.detectLastPoint(DetectRequest body)" - summary: "This operation generates a model using points before the latest one." - parameters: - - description: "Time series points and period if needed. Advanced model parameters can also be set in the request." - name: "body" - type: "" - syntax: "public Mono detectLastPoint(DetectRequest body)" - desc: "This operation generates a model using points before the latest one. With this method, only historical points are used to determine whether the target point is an anomaly. The latest point detecting operation matches the scenario of real-time monitoring of business metrics." - returns: - description: "the response of last anomaly detection." - type: "Mono<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectLastPointWithResponse(com.azure.ai.anomalydetector.models.DetectRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectLastPointWithResponse(DetectRequest body)" - name: "detectLastPointWithResponse(DetectRequest body)" - nameWithType: "AnomalyDetectorAsyncClient.detectLastPointWithResponse(DetectRequest body)" - summary: "This operation generates a model using points before the latest one." - parameters: - - description: "Time series points and period if needed. Advanced model parameters can also be set in the request." - name: "body" - type: "" - syntax: "public Mono> detectLastPointWithResponse(DetectRequest body)" - desc: "This operation generates a model using points before the latest one. With this method, only historical points are used to determine whether the target point is an anomaly. The latest point detecting operation matches the scenario of real-time monitoring of business metrics." - returns: - description: "the response of last anomaly detection." - type: "Mono<<>>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.exportModel(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.exportModel(UUID modelId)" - name: "exportModel(UUID modelId)" - nameWithType: "AnomalyDetectorAsyncClient.exportModel(UUID modelId)" - summary: "Export multivariate anomaly detection model based on modelId." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - syntax: "public Flux exportModel(UUID modelId)" - desc: "Export multivariate anomaly detection model based on modelId." - returns: - description: "the response." - type: "Flux<ByteBuffer>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.exportModelWithResponse(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.exportModelWithResponse(UUID modelId)" - name: "exportModelWithResponse(UUID modelId)" - nameWithType: "AnomalyDetectorAsyncClient.exportModelWithResponse(UUID modelId)" - summary: "Export multivariate anomaly detection model based on modelId." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - syntax: "public Mono exportModelWithResponse(UUID modelId)" - desc: "Export multivariate anomaly detection model based on modelId." - returns: - description: "the response." - type: "Mono<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getDetectionResult(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getDetectionResult(UUID resultId)" - name: "getDetectionResult(UUID resultId)" - nameWithType: "AnomalyDetectorAsyncClient.getDetectionResult(UUID resultId)" - summary: "Get multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." - parameters: - - description: "Result identifier." - name: "resultId" - type: "UUID" - syntax: "public Mono getDetectionResult(UUID resultId)" - desc: "Get multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." - returns: - description: "multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." - type: "Mono<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getDetectionResultWithResponse(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getDetectionResultWithResponse(UUID resultId)" - name: "getDetectionResultWithResponse(UUID resultId)" - nameWithType: "AnomalyDetectorAsyncClient.getDetectionResultWithResponse(UUID resultId)" - summary: "Get multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." - parameters: - - description: "Result identifier." - name: "resultId" - type: "UUID" - syntax: "public Mono> getDetectionResultWithResponse(UUID resultId)" - desc: "Get multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." - returns: - description: "multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." - type: "Mono<<>>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateModel(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateModel(UUID modelId)" - name: "getMultivariateModel(UUID modelId)" - nameWithType: "AnomalyDetectorAsyncClient.getMultivariateModel(UUID modelId)" - summary: "Get detailed information of multivariate model, including the training status and variables used in the model." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - syntax: "public Mono getMultivariateModel(UUID modelId)" - desc: "Get detailed information of multivariate model, including the training status and variables used in the model." - returns: - description: "detailed information of multivariate model, including the training status and variables used in the\n model." - type: "Mono<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateModelWithResponse(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateModelWithResponse(UUID modelId)" - name: "getMultivariateModelWithResponse(UUID modelId)" - nameWithType: "AnomalyDetectorAsyncClient.getMultivariateModelWithResponse(UUID modelId)" - summary: "Get detailed information of multivariate model, including the training status and variables used in the model." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - syntax: "public Mono> getMultivariateModelWithResponse(UUID modelId)" - desc: "Get detailed information of multivariate model, including the training status and variables used in the model." - returns: - description: "detailed information of multivariate model, including the training status and variables used in the\n model." - type: "Mono<<>>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.lastDetectAnomaly(java.util.UUID,com.azure.ai.anomalydetector.models.LastDetectionRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.lastDetectAnomaly(UUID modelId, LastDetectionRequest body)" - name: "lastDetectAnomaly(UUID modelId, LastDetectionRequest body)" - nameWithType: "AnomalyDetectorAsyncClient.lastDetectAnomaly(UUID modelId, LastDetectionRequest body)" - summary: "Synchronized API for anomaly detection." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - - description: "Request for last detection." - name: "body" - type: "" - syntax: "public Mono lastDetectAnomaly(UUID modelId, LastDetectionRequest body)" - desc: "Synchronized API for anomaly detection." - returns: - description: "the response." - type: "Mono<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.lastDetectAnomalyWithResponse(java.util.UUID,com.azure.ai.anomalydetector.models.LastDetectionRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.lastDetectAnomalyWithResponse(UUID modelId, LastDetectionRequest body)" - name: "lastDetectAnomalyWithResponse(UUID modelId, LastDetectionRequest body)" - nameWithType: "AnomalyDetectorAsyncClient.lastDetectAnomalyWithResponse(UUID modelId, LastDetectionRequest body)" - summary: "Synchronized API for anomaly detection." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - - description: "Request for last detection." - name: "body" - type: "" - syntax: "public Mono> lastDetectAnomalyWithResponse(UUID modelId, LastDetectionRequest body)" - desc: "Synchronized API for anomaly detection." - returns: - description: "the response." - type: "Mono<<>>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.listMultivariateModel(java.lang.Integer,java.lang.Integer)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.listMultivariateModel(Integer skip, Integer top)" - name: "listMultivariateModel(Integer skip, Integer top)" - nameWithType: "AnomalyDetectorAsyncClient.listMultivariateModel(Integer skip, Integer top)" - summary: "List models of a subscription." - parameters: - - description: "$skip indicates how many models will be skipped." - name: "skip" - type: "Integer" - - description: "$top indicates how many models will be fetched." - name: "top" - type: "Integer" - syntax: "public PagedFlux listMultivariateModel(Integer skip, Integer top)" - desc: "List models of a subscription." - returns: - description: "response of listing models." - type: "<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.listMultivariateModelNextSinglePage(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.listMultivariateModelNextSinglePage(String nextLink)" - name: "listMultivariateModelNextSinglePage(String nextLink)" - nameWithType: "AnomalyDetectorAsyncClient.listMultivariateModelNextSinglePage(String nextLink)" - summary: "Get the next page of items." - parameters: - - description: "The nextLink parameter." - name: "nextLink" type: "String" - syntax: "public Mono> listMultivariateModelNextSinglePage(String nextLink)" - desc: "Get the next page of items." + syntax: "public Mono deleteMultivariateModel(String modelId)" + desc: "Delete Multivariate Model\n\nDelete an existing multivariate model according to the modelId." returns: - description: "response of listing models." - type: "Mono<<>>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.listMultivariateModelSinglePage(java.lang.Integer,java.lang.Integer)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.listMultivariateModelSinglePage(Integer skip, Integer top)" - name: "listMultivariateModelSinglePage(Integer skip, Integer top)" - nameWithType: "AnomalyDetectorAsyncClient.listMultivariateModelSinglePage(Integer skip, Integer top)" - summary: "List models of a subscription." - parameters: - - description: "$skip indicates how many models will be skipped." - name: "skip" - type: "Integer" - - description: "$top indicates how many models will be fetched." - name: "top" - type: "Integer" - syntax: "public Mono> listMultivariateModelSinglePage(Integer skip, Integer top)" - desc: "List models of a subscription." - returns: - description: "response of listing models." - type: "Mono<<>>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.trainMultivariateModel(com.azure.ai.anomalydetector.models.ModelInfo)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.trainMultivariateModel(ModelInfo body)" - name: "trainMultivariateModel(ModelInfo body)" - nameWithType: "AnomalyDetectorAsyncClient.trainMultivariateModel(ModelInfo body)" - summary: "Create and train a multivariate anomaly detection model." - parameters: - - description: "Training request." - name: "body" - type: "" - syntax: "public Mono trainMultivariateModel(ModelInfo body)" - desc: "Create and train a multivariate anomaly detection model. The request must include a source parameter to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be in a single CSV file in which the first column is timestamp and the second column is value." - returns: - description: "the completion." + description: "A that completes when a successful response is received." type: "Mono<Void>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.trainMultivariateModelWithResponse(com.azure.ai.anomalydetector.models.ModelInfo)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.trainMultivariateModelWithResponse(ModelInfo body)" - name: "trainMultivariateModelWithResponse(ModelInfo body)" - nameWithType: "AnomalyDetectorAsyncClient.trainMultivariateModelWithResponse(ModelInfo body)" - summary: "Create and train a multivariate anomaly detection model." +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.deleteMultivariateModelWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.deleteMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + name: "deleteMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorAsyncClient.deleteMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + summary: "Delete Multivariate Model" parameters: - - description: "Training request." - name: "body" - type: "" - syntax: "public Mono trainMultivariateModelWithResponse(ModelInfo body)" - desc: "Create and train a multivariate anomaly detection model. The request must include a source parameter to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be in a single CSV file in which the first column is timestamp and the second column is value." + - description: "Model identifier." + name: "modelId" + type: "String" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Mono> deleteMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + desc: "Delete Multivariate Model\n\nDelete an existing multivariate model according to the modelId." returns: - description: "the completion." - type: "Mono<>" + description: "the on successful completion of ." + type: "Mono<<Void>>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectMultivariateBatchAnomaly(java.lang.String,com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectMultivariateBatchAnomaly(String modelId, MultivariateBatchDetectionOptions options)" + name: "detectMultivariateBatchAnomaly(String modelId, MultivariateBatchDetectionOptions options)" + nameWithType: "AnomalyDetectorAsyncClient.detectMultivariateBatchAnomaly(String modelId, MultivariateBatchDetectionOptions options)" + summary: "Detect Multivariate Anomaly" + parameters: + - description: "Model identifier." + name: "modelId" + type: "String" + - description: "Request of multivariate anomaly detection." + name: "options" + type: "" + syntax: "public Mono detectMultivariateBatchAnomaly(String modelId, MultivariateBatchDetectionOptions options)" + desc: "Detect Multivariate Anomaly\n\nSubmit multivariate anomaly detection task with the modelId of trained model and inference data, the input schema should be the same with the training request. The request will complete asynchronously and return a resultId to query the detection result.The request should be a source link to indicate an externally accessible Azure storage Uri, either pointed to an Azure blob storage folder, or pointed to a CSV file in Azure blob storage." + returns: + description: "detection results for the given resultId on successful completion of ." + type: "Mono<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectMultivariateBatchAnomalyWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectMultivariateBatchAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + name: "detectMultivariateBatchAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorAsyncClient.detectMultivariateBatchAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + summary: "Detect Multivariate Anomaly" + parameters: + - description: "Model identifier." + name: "modelId" + type: "String" + - description: "Request of multivariate anomaly detection." + name: "options" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Mono> detectMultivariateBatchAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + desc: "Detect Multivariate Anomaly\n\nSubmit multivariate anomaly detection task with the modelId of trained model and inference data, the input schema should be the same with the training request. The request will complete asynchronously and return a resultId to query the detection result.The request should be a source link to indicate an externally accessible Azure storage Uri, either pointed to an Azure blob storage folder, or pointed to a CSV file in Azure blob storage.\n\n**Request Body Schema**\n\n```java\n{\n dataSource: String (Required)\n topContributorCount: int (Required)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n resultId: String (Required)\n summary (Required): {\n status: String(CREATED/RUNNING/READY/FAILED) (Required)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n setupInfo (Required): {\n dataSource: String (Required)\n topContributorCount: int (Required)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n }\n }\n results (Required): [\n (Required){\n timestamp: OffsetDateTime (Required)\n value (Optional): {\n isAnomaly: boolean (Required)\n severity: double (Required)\n score: double (Required)\n interpretation (Optional): [\n (Optional){\n variable: String (Optional)\n contributionScore: Double (Optional)\n correlationChanges (Optional): {\n changedVariables (Optional): [\n String (Optional)\n ]\n }\n }\n ]\n }\n errors (Optional): [\n (recursive schema, see above)\n ]\n }\n ]\n }\n```" + returns: + description: "detection results for the given resultId along with on successful completion of ." + type: "Mono<<>>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectMultivariateLastAnomaly(java.lang.String,com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectMultivariateLastAnomaly(String modelId, MultivariateLastDetectionOptions options)" + name: "detectMultivariateLastAnomaly(String modelId, MultivariateLastDetectionOptions options)" + nameWithType: "AnomalyDetectorAsyncClient.detectMultivariateLastAnomaly(String modelId, MultivariateLastDetectionOptions options)" + summary: "Detect anomalies in the last point of the request body" + parameters: + - description: "Model identifier." + name: "modelId" + type: "String" + - description: "Request of last detection." + name: "options" + type: "" + syntax: "public Mono detectMultivariateLastAnomaly(String modelId, MultivariateLastDetectionOptions options)" + desc: "Detect anomalies in the last point of the request body\n\nSubmit multivariate anomaly detection task with the modelId of trained model and inference data, and the inference data should be put into request body in a JSON format. The request will complete synchronously and return the detection immediately in the response body." + returns: + description: "results of last detection on successful completion of ." + type: "Mono<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectMultivariateLastAnomalyWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectMultivariateLastAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + name: "detectMultivariateLastAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorAsyncClient.detectMultivariateLastAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + summary: "Detect anomalies in the last point of the request body" + parameters: + - description: "Model identifier." + name: "modelId" + type: "String" + - description: "Request of last detection." + name: "options" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Mono> detectMultivariateLastAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + desc: "Detect anomalies in the last point of the request body\n\nSubmit multivariate anomaly detection task with the modelId of trained model and inference data, and the inference data should be put into request body in a JSON format. The request will complete synchronously and return the detection immediately in the response body.\n\n**Request Body Schema**\n\n```java\n{\n variables (Required): [\n (Required){\n variable: String (Required)\n timestamps (Required): [\n String (Required)\n ]\n values (Required): [\n double (Required)\n ]\n }\n ]\n topContributorCount: int (Required)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n results (Optional): [\n (Optional){\n timestamp: OffsetDateTime (Required)\n value (Optional): {\n isAnomaly: boolean (Required)\n severity: double (Required)\n score: double (Required)\n interpretation (Optional): [\n (Optional){\n variable: String (Optional)\n contributionScore: Double (Optional)\n correlationChanges (Optional): {\n changedVariables (Optional): [\n String (Optional)\n ]\n }\n }\n ]\n }\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n }\n ]\n }\n```" + returns: + description: "results of last detection along with on successful completion of ." + type: "Mono<<>>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateChangePoint(com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateChangePoint(UnivariateChangePointDetectionOptions options)" + name: "detectUnivariateChangePoint(UnivariateChangePointDetectionOptions options)" + nameWithType: "AnomalyDetectorAsyncClient.detectUnivariateChangePoint(UnivariateChangePointDetectionOptions options)" + summary: "Detect change point for the entire series" + parameters: + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + syntax: "public Mono detectUnivariateChangePoint(UnivariateChangePointDetectionOptions options)" + desc: "Detect change point for the entire series\n\nEvaluate change point score of every series point." + returns: + description: "the response of change point detection on successful completion of ." + type: "Mono<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateChangePointWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateChangePointWithResponse(BinaryData options, RequestOptions requestOptions)" + name: "detectUnivariateChangePointWithResponse(BinaryData options, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorAsyncClient.detectUnivariateChangePointWithResponse(BinaryData options, RequestOptions requestOptions)" + summary: "Detect change point for the entire series" + parameters: + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Mono> detectUnivariateChangePointWithResponse(BinaryData options, RequestOptions requestOptions)" + desc: "Detect change point for the entire series\n\nEvaluate change point score of every series point.\n\n**Request Body Schema**\n\n```java\n{\n series (Required): [\n (Required){\n timestamp: OffsetDateTime (Optional)\n value: double (Required)\n }\n ]\n granularity: String(yearly/monthly/weekly/daily/hourly/minutely/secondly/microsecond/none) (Required)\n customInterval: Integer (Optional)\n period: Integer (Optional)\n stableTrendWindow: Integer (Optional)\n threshold: Double (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n period: Integer (Optional)\n isChangePoint (Optional): [\n boolean (Optional)\n ]\n confidenceScores (Optional): [\n double (Optional)\n ]\n }\n```" + returns: + description: "the response of change point detection along with on successful completion of ." + type: "Mono<<>>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateEntireSeries(com.azure.ai.anomalydetector.models.UnivariateDetectionOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateEntireSeries(UnivariateDetectionOptions options)" + name: "detectUnivariateEntireSeries(UnivariateDetectionOptions options)" + nameWithType: "AnomalyDetectorAsyncClient.detectUnivariateEntireSeries(UnivariateDetectionOptions options)" + summary: "Detect anomalies for the entire series in batch." + parameters: + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + syntax: "public Mono detectUnivariateEntireSeries(UnivariateDetectionOptions options)" + desc: "Detect anomalies for the entire series in batch.\n\nThis operation generates a model with an entire series, each point is detected with the same model. With this method, points before and after a certain point are used to determine whether it is an anomaly. The entire detection can give user an overall status of the time series." + returns: + description: "the response of entire anomaly detection on successful completion of ." + type: "Mono<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateEntireSeriesWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateEntireSeriesWithResponse(BinaryData options, RequestOptions requestOptions)" + name: "detectUnivariateEntireSeriesWithResponse(BinaryData options, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorAsyncClient.detectUnivariateEntireSeriesWithResponse(BinaryData options, RequestOptions requestOptions)" + summary: "Detect anomalies for the entire series in batch." + parameters: + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Mono> detectUnivariateEntireSeriesWithResponse(BinaryData options, RequestOptions requestOptions)" + desc: "Detect anomalies for the entire series in batch.\n\nThis operation generates a model with an entire series, each point is detected with the same model. With this method, points before and after a certain point are used to determine whether it is an anomaly. The entire detection can give user an overall status of the time series.\n\n**Request Body Schema**\n\n```java\n{\n series (Required): [\n (Required){\n timestamp: OffsetDateTime (Optional)\n value: double (Required)\n }\n ]\n granularity: String(yearly/monthly/weekly/daily/hourly/minutely/secondly/microsecond/none) (Optional)\n customInterval: Integer (Optional)\n period: Integer (Optional)\n maxAnomalyRatio: Double (Optional)\n sensitivity: Integer (Optional)\n imputeMode: String(auto/previous/linear/fixed/zero/notFill) (Optional)\n imputeFixedValue: Double (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n period: int (Required)\n expectedValues (Required): [\n double (Required)\n ]\n upperMargins (Required): [\n double (Required)\n ]\n lowerMargins (Required): [\n double (Required)\n ]\n isAnomaly (Required): [\n boolean (Required)\n ]\n isNegativeAnomaly (Required): [\n boolean (Required)\n ]\n isPositiveAnomaly (Required): [\n boolean (Required)\n ]\n severity (Optional): [\n double (Optional)\n ]\n }\n```" + returns: + description: "the response of entire anomaly detection along with on successful completion of ." + type: "Mono<<>>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateLastPoint(com.azure.ai.anomalydetector.models.UnivariateDetectionOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateLastPoint(UnivariateDetectionOptions options)" + name: "detectUnivariateLastPoint(UnivariateDetectionOptions options)" + nameWithType: "AnomalyDetectorAsyncClient.detectUnivariateLastPoint(UnivariateDetectionOptions options)" + summary: "Detect anomaly status of the latest point in time series." + parameters: + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + syntax: "public Mono detectUnivariateLastPoint(UnivariateDetectionOptions options)" + desc: "Detect anomaly status of the latest point in time series.\n\nThis operation generates a model using the points that you sent into the API, and based on all data to determine whether the last point is anomalous." + returns: + description: "the response of last anomaly detection on successful completion of ." + type: "Mono<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateLastPointWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.detectUnivariateLastPointWithResponse(BinaryData options, RequestOptions requestOptions)" + name: "detectUnivariateLastPointWithResponse(BinaryData options, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorAsyncClient.detectUnivariateLastPointWithResponse(BinaryData options, RequestOptions requestOptions)" + summary: "Detect anomaly status of the latest point in time series." + parameters: + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Mono> detectUnivariateLastPointWithResponse(BinaryData options, RequestOptions requestOptions)" + desc: "Detect anomaly status of the latest point in time series.\n\nThis operation generates a model using the points that you sent into the API, and based on all data to determine whether the last point is anomalous.\n\n**Request Body Schema**\n\n```java\n{\n series (Required): [\n (Required){\n timestamp: OffsetDateTime (Optional)\n value: double (Required)\n }\n ]\n granularity: String(yearly/monthly/weekly/daily/hourly/minutely/secondly/microsecond/none) (Optional)\n customInterval: Integer (Optional)\n period: Integer (Optional)\n maxAnomalyRatio: Double (Optional)\n sensitivity: Integer (Optional)\n imputeMode: String(auto/previous/linear/fixed/zero/notFill) (Optional)\n imputeFixedValue: Double (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n period: int (Required)\n suggestedWindow: int (Required)\n expectedValue: double (Required)\n upperMargin: double (Required)\n lowerMargin: double (Required)\n isAnomaly: boolean (Required)\n isNegativeAnomaly: boolean (Required)\n isPositiveAnomaly: boolean (Required)\n severity: Double (Optional)\n }\n```" + returns: + description: "the response of last anomaly detection along with on successful completion of ." + type: "Mono<<>>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateBatchDetectionResult(java.lang.String)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateBatchDetectionResult(String resultId)" + name: "getMultivariateBatchDetectionResult(String resultId)" + nameWithType: "AnomalyDetectorAsyncClient.getMultivariateBatchDetectionResult(String resultId)" + summary: "Get Multivariate Anomaly Detection Result" + parameters: + - description: "ID of a batch detection result." + name: "resultId" + type: "String" + syntax: "public Mono getMultivariateBatchDetectionResult(String resultId)" + desc: "Get Multivariate Anomaly Detection Result\n\nFor asynchronous inference, get multivariate anomaly detection result based on resultId returned by the BatchDetectAnomaly api." + returns: + description: "detection results for the given resultId on successful completion of ." + type: "Mono<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateBatchDetectionResultWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateBatchDetectionResultWithResponse(String resultId, RequestOptions requestOptions)" + name: "getMultivariateBatchDetectionResultWithResponse(String resultId, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorAsyncClient.getMultivariateBatchDetectionResultWithResponse(String resultId, RequestOptions requestOptions)" + summary: "Get Multivariate Anomaly Detection Result" + parameters: + - description: "ID of a batch detection result." + name: "resultId" + type: "String" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Mono> getMultivariateBatchDetectionResultWithResponse(String resultId, RequestOptions requestOptions)" + desc: "Get Multivariate Anomaly Detection Result\n\nFor asynchronous inference, get multivariate anomaly detection result based on resultId returned by the BatchDetectAnomaly api.\n\n**Response Body Schema**\n\n```java\n{\n resultId: String (Required)\n summary (Required): {\n status: String(CREATED/RUNNING/READY/FAILED) (Required)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n setupInfo (Required): {\n dataSource: String (Required)\n topContributorCount: int (Required)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n }\n }\n results (Required): [\n (Required){\n timestamp: OffsetDateTime (Required)\n value (Optional): {\n isAnomaly: boolean (Required)\n severity: double (Required)\n score: double (Required)\n interpretation (Optional): [\n (Optional){\n variable: String (Optional)\n contributionScore: Double (Optional)\n correlationChanges (Optional): {\n changedVariables (Optional): [\n String (Optional)\n ]\n }\n }\n ]\n }\n errors (Optional): [\n (recursive schema, see above)\n ]\n }\n ]\n }\n```" + returns: + description: "detection results for the given resultId along with on successful completion of ." + type: "Mono<<>>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateModel(java.lang.String)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateModel(String modelId)" + name: "getMultivariateModel(String modelId)" + nameWithType: "AnomalyDetectorAsyncClient.getMultivariateModel(String modelId)" + summary: "Get Multivariate Model" + parameters: + - description: "Model identifier." + name: "modelId" + type: "String" + syntax: "public Mono getMultivariateModel(String modelId)" + desc: "Get Multivariate Model\n\nGet detailed information of multivariate model, including the training status and variables used in the model." + returns: + description: "detailed information of multivariate model, including the training status and variables used in the model\n on successful completion of ." + type: "Mono<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateModelWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.getMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + name: "getMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorAsyncClient.getMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + summary: "Get Multivariate Model" + parameters: + - description: "Model identifier." + name: "modelId" + type: "String" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Mono> getMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + desc: "Get Multivariate Model\n\nGet detailed information of multivariate model, including the training status and variables used in the model.\n\n**Response Body Schema**\n\n```java\n{\n modelId: String (Required)\n createdTime: OffsetDateTime (Required)\n lastUpdatedTime: OffsetDateTime (Required)\n modelInfo (Optional): {\n dataSource: String (Required)\n dataSchema: String(OneTable/MultiTable) (Optional)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n displayName: String (Optional)\n slidingWindow: Integer (Optional)\n alignPolicy (Optional): {\n alignMode: String(Inner/Outer) (Optional)\n fillNAMethod: String(Previous/Subsequent/Linear/Zero/Fixed) (Optional)\n paddingValue: Double (Optional)\n }\n status: String(CREATED/RUNNING/READY/FAILED) (Optional)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n diagnosticsInfo (Optional): {\n modelState (Optional): {\n epochIds (Optional): [\n int (Optional)\n ]\n trainLosses (Optional): [\n double (Optional)\n ]\n validationLosses (Optional): [\n double (Optional)\n ]\n latenciesInSeconds (Optional): [\n double (Optional)\n ]\n }\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n }\n }\n }\n```" + returns: + description: "detailed information of multivariate model, including the training status and variables used in the model\n along with on successful completion of ." + type: "Mono<<>>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.listMultivariateModels()" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.listMultivariateModels()" + name: "listMultivariateModels()" + nameWithType: "AnomalyDetectorAsyncClient.listMultivariateModels()" + summary: "List Multivariate Models" + syntax: "public PagedFlux listMultivariateModels()" + desc: "List Multivariate Models\n\nList models of a resource." + returns: + description: "response of listing models as paginated response with ." + type: "<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.listMultivariateModels(com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.listMultivariateModels(RequestOptions requestOptions)" + name: "listMultivariateModels(RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorAsyncClient.listMultivariateModels(RequestOptions requestOptions)" + summary: "List Multivariate Models" + parameters: + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public PagedFlux listMultivariateModels(RequestOptions requestOptions)" + desc: "List Multivariate Models\n\nList models of a resource.\n\n**Query Parameters**\n\n | ---- | ------- | -------- | ----------------------------------------------- |\n | Name | Type | Required | Description |\n | skip | Integer | No | Skip indicates how many models will be skipped. |\n | top | Integer | No | Top indicates how many models will be fetched. |\n\nYou can add these to a request with \n\n**Response Body Schema**\n\n```java\n{\n modelId: String (Required)\n createdTime: OffsetDateTime (Required)\n lastUpdatedTime: OffsetDateTime (Required)\n modelInfo (Optional): {\n dataSource: String (Required)\n dataSchema: String(OneTable/MultiTable) (Optional)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n displayName: String (Optional)\n slidingWindow: Integer (Optional)\n alignPolicy (Optional): {\n alignMode: String(Inner/Outer) (Optional)\n fillNAMethod: String(Previous/Subsequent/Linear/Zero/Fixed) (Optional)\n paddingValue: Double (Optional)\n }\n status: String(CREATED/RUNNING/READY/FAILED) (Optional)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n diagnosticsInfo (Optional): {\n modelState (Optional): {\n epochIds (Optional): [\n int (Optional)\n ]\n trainLosses (Optional): [\n double (Optional)\n ]\n validationLosses (Optional): [\n double (Optional)\n ]\n latenciesInSeconds (Optional): [\n double (Optional)\n ]\n }\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n }\n }\n }\n```" + returns: + description: "response of listing models as paginated response with ." + type: "<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.trainMultivariateModel(com.azure.ai.anomalydetector.models.ModelInfo)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.trainMultivariateModel(ModelInfo modelInfo)" + name: "trainMultivariateModel(ModelInfo modelInfo)" + nameWithType: "AnomalyDetectorAsyncClient.trainMultivariateModel(ModelInfo modelInfo)" + summary: "Train a Multivariate Anomaly Detection Model" + parameters: + - description: "Model information." + name: "modelInfo" + type: "" + syntax: "public Mono trainMultivariateModel(ModelInfo modelInfo)" + desc: "Train a Multivariate Anomaly Detection Model\n\nCreate and train a multivariate anomaly detection model. The request must include a source parameter to indicate an externally accessible Azure blob storage URI.There are two types of data input: An URI pointed to an Azure blob storage folder which contains multiple CSV files, and each CSV file contains two columns, timestamp and variable. Another type of input is an URI pointed to a CSV file in Azure blob storage, which contains all the variables and a timestamp column." + returns: + description: "response of getting a model on successful completion of ." + type: "Mono<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.trainMultivariateModelWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient.trainMultivariateModelWithResponse(BinaryData modelInfo, RequestOptions requestOptions)" + name: "trainMultivariateModelWithResponse(BinaryData modelInfo, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorAsyncClient.trainMultivariateModelWithResponse(BinaryData modelInfo, RequestOptions requestOptions)" + summary: "Train a Multivariate Anomaly Detection Model" + parameters: + - description: "Model information." + name: "modelInfo" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Mono> trainMultivariateModelWithResponse(BinaryData modelInfo, RequestOptions requestOptions)" + desc: "Train a Multivariate Anomaly Detection Model\n\nCreate and train a multivariate anomaly detection model. The request must include a source parameter to indicate an externally accessible Azure blob storage URI.There are two types of data input: An URI pointed to an Azure blob storage folder which contains multiple CSV files, and each CSV file contains two columns, timestamp and variable. Another type of input is an URI pointed to a CSV file in Azure blob storage, which contains all the variables and a timestamp column.\n\n**Request Body Schema**\n\n```java\n{\n dataSource: String (Required)\n dataSchema: String(OneTable/MultiTable) (Optional)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n displayName: String (Optional)\n slidingWindow: Integer (Optional)\n alignPolicy (Optional): {\n alignMode: String(Inner/Outer) (Optional)\n fillNAMethod: String(Previous/Subsequent/Linear/Zero/Fixed) (Optional)\n paddingValue: Double (Optional)\n }\n status: String(CREATED/RUNNING/READY/FAILED) (Optional)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n diagnosticsInfo (Optional): {\n modelState (Optional): {\n epochIds (Optional): [\n int (Optional)\n ]\n trainLosses (Optional): [\n double (Optional)\n ]\n validationLosses (Optional): [\n double (Optional)\n ]\n latenciesInSeconds (Optional): [\n double (Optional)\n ]\n }\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n modelId: String (Required)\n createdTime: OffsetDateTime (Required)\n lastUpdatedTime: OffsetDateTime (Required)\n modelInfo (Optional): {\n dataSource: String (Required)\n dataSchema: String(OneTable/MultiTable) (Optional)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n displayName: String (Optional)\n slidingWindow: Integer (Optional)\n alignPolicy (Optional): {\n alignMode: String(Inner/Outer) (Optional)\n fillNAMethod: String(Previous/Subsequent/Linear/Zero/Fixed) (Optional)\n paddingValue: Double (Optional)\n }\n status: String(CREATED/RUNNING/READY/FAILED) (Optional)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n diagnosticsInfo (Optional): {\n modelState (Optional): {\n epochIds (Optional): [\n int (Optional)\n ]\n trainLosses (Optional): [\n double (Optional)\n ]\n validationLosses (Optional): [\n double (Optional)\n ]\n latenciesInSeconds (Optional): [\n double (Optional)\n ]\n }\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n }\n }\n }\n```" + returns: + description: "response of getting a model along with on successful completion of ." + type: "Mono<<>>" type: "class" desc: "Initializes a new instance of the asynchronous AnomalyDetectorClient type." metadata: {} package: "com.azure.ai.anomalydetector" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorClient.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorClient.yml index 7016bcf1f82f..ae32a0512726 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorClient.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorClient.yml @@ -22,358 +22,320 @@ inheritedClassMethods: - "wait" syntax: "public final class **AnomalyDetectorClient**" methods: -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.deleteMultivariateModel(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.deleteMultivariateModel(UUID modelId)" - name: "deleteMultivariateModel(UUID modelId)" - nameWithType: "AnomalyDetectorClient.deleteMultivariateModel(UUID modelId)" - summary: "Delete an existing multivariate model according to the modelId." +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.deleteMultivariateModel(java.lang.String)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.deleteMultivariateModel(String modelId)" + name: "deleteMultivariateModel(String modelId)" + nameWithType: "AnomalyDetectorClient.deleteMultivariateModel(String modelId)" + summary: "Delete Multivariate Model" parameters: - description: "Model identifier." name: "modelId" - type: "UUID" - syntax: "public void deleteMultivariateModel(UUID modelId)" - desc: "Delete an existing multivariate model according to the modelId." -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.deleteMultivariateModelWithResponse(java.util.UUID,com.azure.core.util.Context)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.deleteMultivariateModelWithResponse(UUID modelId, Context context)" - name: "deleteMultivariateModelWithResponse(UUID modelId, Context context)" - nameWithType: "AnomalyDetectorClient.deleteMultivariateModelWithResponse(UUID modelId, Context context)" - summary: "Delete an existing multivariate model according to the modelId." + type: "String" + syntax: "public void deleteMultivariateModel(String modelId)" + desc: "Delete Multivariate Model\n\nDelete an existing multivariate model according to the modelId." +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.deleteMultivariateModelWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.deleteMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + name: "deleteMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorClient.deleteMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + summary: "Delete Multivariate Model" parameters: - description: "Model identifier." name: "modelId" - type: "UUID" - - description: "The context to associate with this operation." - name: "context" - type: "" - syntax: "public Response deleteMultivariateModelWithResponse(UUID modelId, Context context)" - desc: "Delete an existing multivariate model according to the modelId." + type: "String" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Response deleteMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + desc: "Delete Multivariate Model\n\nDelete an existing multivariate model according to the modelId." returns: - description: "the response." + description: "the ." type: "<Void>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectAnomaly(java.util.UUID,com.azure.ai.anomalydetector.models.DetectionRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectAnomaly(UUID modelId, DetectionRequest body)" - name: "detectAnomaly(UUID modelId, DetectionRequest body)" - nameWithType: "AnomalyDetectorClient.detectAnomaly(UUID modelId, DetectionRequest body)" - summary: "Submit detection multivariate anomaly task with the trained model of modelId, the input schema should be the same with the training request." +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectMultivariateBatchAnomaly(java.lang.String,com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectMultivariateBatchAnomaly(String modelId, MultivariateBatchDetectionOptions options)" + name: "detectMultivariateBatchAnomaly(String modelId, MultivariateBatchDetectionOptions options)" + nameWithType: "AnomalyDetectorClient.detectMultivariateBatchAnomaly(String modelId, MultivariateBatchDetectionOptions options)" + summary: "Detect Multivariate Anomaly" parameters: - description: "Model identifier." name: "modelId" - type: "UUID" - - description: "Detect anomaly request." - name: "body" - type: "" - syntax: "public void detectAnomaly(UUID modelId, DetectionRequest body)" - desc: "Submit detection multivariate anomaly task with the trained model of modelId, the input schema should be the same with the training request. Thus request will be complete asynchronously and will return a resultId for querying the detection result.The request should be a source link to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be as follows: the first column is timestamp and the second column is value." -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectAnomalyWithResponse(java.util.UUID,com.azure.ai.anomalydetector.models.DetectionRequest,com.azure.core.util.Context)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectAnomalyWithResponse(UUID modelId, DetectionRequest body, Context context)" - name: "detectAnomalyWithResponse(UUID modelId, DetectionRequest body, Context context)" - nameWithType: "AnomalyDetectorClient.detectAnomalyWithResponse(UUID modelId, DetectionRequest body, Context context)" - summary: "Submit detection multivariate anomaly task with the trained model of modelId, the input schema should be the same with the training request." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - - description: "Detect anomaly request." - name: "body" - type: "" - - description: "The context to associate with this operation." - name: "context" - type: "" - syntax: "public DetectAnomalyResponse detectAnomalyWithResponse(UUID modelId, DetectionRequest body, Context context)" - desc: "Submit detection multivariate anomaly task with the trained model of modelId, the input schema should be the same with the training request. Thus request will be complete asynchronously and will return a resultId for querying the detection result.The request should be a source link to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be as follows: the first column is timestamp and the second column is value." + type: "String" + - description: "Request of multivariate anomaly detection." + name: "options" + type: "" + syntax: "public MultivariateDetectionResult detectMultivariateBatchAnomaly(String modelId, MultivariateBatchDetectionOptions options)" + desc: "Detect Multivariate Anomaly\n\nSubmit multivariate anomaly detection task with the modelId of trained model and inference data, the input schema should be the same with the training request. The request will complete asynchronously and return a resultId to query the detection result.The request should be a source link to indicate an externally accessible Azure storage Uri, either pointed to an Azure blob storage folder, or pointed to a CSV file in Azure blob storage." returns: - description: "the response." - type: "" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectChangePoint(com.azure.ai.anomalydetector.models.ChangePointDetectRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectChangePoint(ChangePointDetectRequest body)" - name: "detectChangePoint(ChangePointDetectRequest body)" - nameWithType: "AnomalyDetectorClient.detectChangePoint(ChangePointDetectRequest body)" - summary: "Evaluate change point score of every series point." + description: "detection results for the given resultId." + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectMultivariateBatchAnomalyWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectMultivariateBatchAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + name: "detectMultivariateBatchAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorClient.detectMultivariateBatchAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + summary: "Detect Multivariate Anomaly" parameters: - - description: "Time series points and granularity is needed. Advanced model parameters can also be set in the\n request if needed." - name: "body" - type: "" - syntax: "public ChangePointDetectResponse detectChangePoint(ChangePointDetectRequest body)" - desc: "Evaluate change point score of every series point." + - description: "Model identifier." + name: "modelId" + type: "String" + - description: "Request of multivariate anomaly detection." + name: "options" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Response detectMultivariateBatchAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + desc: "Detect Multivariate Anomaly\n\nSubmit multivariate anomaly detection task with the modelId of trained model and inference data, the input schema should be the same with the training request. The request will complete asynchronously and return a resultId to query the detection result.The request should be a source link to indicate an externally accessible Azure storage Uri, either pointed to an Azure blob storage folder, or pointed to a CSV file in Azure blob storage.\n\n**Request Body Schema**\n\n```java\n{\n dataSource: String (Required)\n topContributorCount: int (Required)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n resultId: String (Required)\n summary (Required): {\n status: String(CREATED/RUNNING/READY/FAILED) (Required)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n setupInfo (Required): {\n dataSource: String (Required)\n topContributorCount: int (Required)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n }\n }\n results (Required): [\n (Required){\n timestamp: OffsetDateTime (Required)\n value (Optional): {\n isAnomaly: boolean (Required)\n severity: double (Required)\n score: double (Required)\n interpretation (Optional): [\n (Optional){\n variable: String (Optional)\n contributionScore: Double (Optional)\n correlationChanges (Optional): {\n changedVariables (Optional): [\n String (Optional)\n ]\n }\n }\n ]\n }\n errors (Optional): [\n (recursive schema, see above)\n ]\n }\n ]\n }\n```" + returns: + description: "detection results for the given resultId along with ." + type: "<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectMultivariateLastAnomaly(java.lang.String,com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectMultivariateLastAnomaly(String modelId, MultivariateLastDetectionOptions options)" + name: "detectMultivariateLastAnomaly(String modelId, MultivariateLastDetectionOptions options)" + nameWithType: "AnomalyDetectorClient.detectMultivariateLastAnomaly(String modelId, MultivariateLastDetectionOptions options)" + summary: "Detect anomalies in the last point of the request body" + parameters: + - description: "Model identifier." + name: "modelId" + type: "String" + - description: "Request of last detection." + name: "options" + type: "" + syntax: "public MultivariateLastDetectionResult detectMultivariateLastAnomaly(String modelId, MultivariateLastDetectionOptions options)" + desc: "Detect anomalies in the last point of the request body\n\nSubmit multivariate anomaly detection task with the modelId of trained model and inference data, and the inference data should be put into request body in a JSON format. The request will complete synchronously and return the detection immediately in the response body." + returns: + description: "results of last detection." + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectMultivariateLastAnomalyWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectMultivariateLastAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + name: "detectMultivariateLastAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorClient.detectMultivariateLastAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + summary: "Detect anomalies in the last point of the request body" + parameters: + - description: "Model identifier." + name: "modelId" + type: "String" + - description: "Request of last detection." + name: "options" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Response detectMultivariateLastAnomalyWithResponse(String modelId, BinaryData options, RequestOptions requestOptions)" + desc: "Detect anomalies in the last point of the request body\n\nSubmit multivariate anomaly detection task with the modelId of trained model and inference data, and the inference data should be put into request body in a JSON format. The request will complete synchronously and return the detection immediately in the response body.\n\n**Request Body Schema**\n\n```java\n{\n variables (Required): [\n (Required){\n variable: String (Required)\n timestamps (Required): [\n String (Required)\n ]\n values (Required): [\n double (Required)\n ]\n }\n ]\n topContributorCount: int (Required)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n results (Optional): [\n (Optional){\n timestamp: OffsetDateTime (Required)\n value (Optional): {\n isAnomaly: boolean (Required)\n severity: double (Required)\n score: double (Required)\n interpretation (Optional): [\n (Optional){\n variable: String (Optional)\n contributionScore: Double (Optional)\n correlationChanges (Optional): {\n changedVariables (Optional): [\n String (Optional)\n ]\n }\n }\n ]\n }\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n }\n ]\n }\n```" + returns: + description: "results of last detection along with ." + type: "<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateChangePoint(com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateChangePoint(UnivariateChangePointDetectionOptions options)" + name: "detectUnivariateChangePoint(UnivariateChangePointDetectionOptions options)" + nameWithType: "AnomalyDetectorClient.detectUnivariateChangePoint(UnivariateChangePointDetectionOptions options)" + summary: "Detect change point for the entire series" + parameters: + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + syntax: "public UnivariateChangePointDetectionResult detectUnivariateChangePoint(UnivariateChangePointDetectionOptions options)" + desc: "Detect change point for the entire series\n\nEvaluate change point score of every series point." returns: description: "the response of change point detection." - type: "" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectChangePointWithResponse(com.azure.ai.anomalydetector.models.ChangePointDetectRequest,com.azure.core.util.Context)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectChangePointWithResponse(ChangePointDetectRequest body, Context context)" - name: "detectChangePointWithResponse(ChangePointDetectRequest body, Context context)" - nameWithType: "AnomalyDetectorClient.detectChangePointWithResponse(ChangePointDetectRequest body, Context context)" - summary: "Evaluate change point score of every series point." + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateChangePointWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateChangePointWithResponse(BinaryData options, RequestOptions requestOptions)" + name: "detectUnivariateChangePointWithResponse(BinaryData options, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorClient.detectUnivariateChangePointWithResponse(BinaryData options, RequestOptions requestOptions)" + summary: "Detect change point for the entire series" parameters: - - description: "Time series points and granularity is needed. Advanced model parameters can also be set in the\n request if needed." - name: "body" - type: "" - - description: "The context to associate with this operation." - name: "context" - type: "" - syntax: "public Response detectChangePointWithResponse(ChangePointDetectRequest body, Context context)" - desc: "Evaluate change point score of every series point." + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Response detectUnivariateChangePointWithResponse(BinaryData options, RequestOptions requestOptions)" + desc: "Detect change point for the entire series\n\nEvaluate change point score of every series point.\n\n**Request Body Schema**\n\n```java\n{\n series (Required): [\n (Required){\n timestamp: OffsetDateTime (Optional)\n value: double (Required)\n }\n ]\n granularity: String(yearly/monthly/weekly/daily/hourly/minutely/secondly/microsecond/none) (Required)\n customInterval: Integer (Optional)\n period: Integer (Optional)\n stableTrendWindow: Integer (Optional)\n threshold: Double (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n period: Integer (Optional)\n isChangePoint (Optional): [\n boolean (Optional)\n ]\n confidenceScores (Optional): [\n double (Optional)\n ]\n }\n```" returns: - description: "the response of change point detection." - type: "<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectEntireSeries(com.azure.ai.anomalydetector.models.DetectRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectEntireSeries(DetectRequest body)" - name: "detectEntireSeries(DetectRequest body)" - nameWithType: "AnomalyDetectorClient.detectEntireSeries(DetectRequest body)" - summary: "This operation generates a model with an entire series, each point is detected with the same model." + description: "the response of change point detection along with ." + type: "<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateEntireSeries(com.azure.ai.anomalydetector.models.UnivariateDetectionOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateEntireSeries(UnivariateDetectionOptions options)" + name: "detectUnivariateEntireSeries(UnivariateDetectionOptions options)" + nameWithType: "AnomalyDetectorClient.detectUnivariateEntireSeries(UnivariateDetectionOptions options)" + summary: "Detect anomalies for the entire series in batch." parameters: - - description: "Time series points and period if needed. Advanced model parameters can also be set in the request." - name: "body" - type: "" - syntax: "public EntireDetectResponse detectEntireSeries(DetectRequest body)" - desc: "This operation generates a model with an entire series, each point is detected with the same model. With this method, points before and after a certain point are used to determine whether it is an anomaly. The entire detection can give user an overall status of the time series." + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + syntax: "public UnivariateEntireDetectionResult detectUnivariateEntireSeries(UnivariateDetectionOptions options)" + desc: "Detect anomalies for the entire series in batch.\n\nThis operation generates a model with an entire series, each point is detected with the same model. With this method, points before and after a certain point are used to determine whether it is an anomaly. The entire detection can give user an overall status of the time series." returns: description: "the response of entire anomaly detection." - type: "" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectEntireSeriesWithResponse(com.azure.ai.anomalydetector.models.DetectRequest,com.azure.core.util.Context)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectEntireSeriesWithResponse(DetectRequest body, Context context)" - name: "detectEntireSeriesWithResponse(DetectRequest body, Context context)" - nameWithType: "AnomalyDetectorClient.detectEntireSeriesWithResponse(DetectRequest body, Context context)" - summary: "This operation generates a model with an entire series, each point is detected with the same model." + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateEntireSeriesWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateEntireSeriesWithResponse(BinaryData options, RequestOptions requestOptions)" + name: "detectUnivariateEntireSeriesWithResponse(BinaryData options, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorClient.detectUnivariateEntireSeriesWithResponse(BinaryData options, RequestOptions requestOptions)" + summary: "Detect anomalies for the entire series in batch." parameters: - - description: "Time series points and period if needed. Advanced model parameters can also be set in the request." - name: "body" - type: "" - - description: "The context to associate with this operation." - name: "context" - type: "" - syntax: "public Response detectEntireSeriesWithResponse(DetectRequest body, Context context)" - desc: "This operation generates a model with an entire series, each point is detected with the same model. With this method, points before and after a certain point are used to determine whether it is an anomaly. The entire detection can give user an overall status of the time series." + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Response detectUnivariateEntireSeriesWithResponse(BinaryData options, RequestOptions requestOptions)" + desc: "Detect anomalies for the entire series in batch.\n\nThis operation generates a model with an entire series, each point is detected with the same model. With this method, points before and after a certain point are used to determine whether it is an anomaly. The entire detection can give user an overall status of the time series.\n\n**Request Body Schema**\n\n```java\n{\n series (Required): [\n (Required){\n timestamp: OffsetDateTime (Optional)\n value: double (Required)\n }\n ]\n granularity: String(yearly/monthly/weekly/daily/hourly/minutely/secondly/microsecond/none) (Optional)\n customInterval: Integer (Optional)\n period: Integer (Optional)\n maxAnomalyRatio: Double (Optional)\n sensitivity: Integer (Optional)\n imputeMode: String(auto/previous/linear/fixed/zero/notFill) (Optional)\n imputeFixedValue: Double (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n period: int (Required)\n expectedValues (Required): [\n double (Required)\n ]\n upperMargins (Required): [\n double (Required)\n ]\n lowerMargins (Required): [\n double (Required)\n ]\n isAnomaly (Required): [\n boolean (Required)\n ]\n isNegativeAnomaly (Required): [\n boolean (Required)\n ]\n isPositiveAnomaly (Required): [\n boolean (Required)\n ]\n severity (Optional): [\n double (Optional)\n ]\n }\n```" returns: - description: "the response of entire anomaly detection." - type: "<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectLastPoint(com.azure.ai.anomalydetector.models.DetectRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectLastPoint(DetectRequest body)" - name: "detectLastPoint(DetectRequest body)" - nameWithType: "AnomalyDetectorClient.detectLastPoint(DetectRequest body)" - summary: "This operation generates a model using points before the latest one." + description: "the response of entire anomaly detection along with ." + type: "<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateLastPoint(com.azure.ai.anomalydetector.models.UnivariateDetectionOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateLastPoint(UnivariateDetectionOptions options)" + name: "detectUnivariateLastPoint(UnivariateDetectionOptions options)" + nameWithType: "AnomalyDetectorClient.detectUnivariateLastPoint(UnivariateDetectionOptions options)" + summary: "Detect anomaly status of the latest point in time series." parameters: - - description: "Time series points and period if needed. Advanced model parameters can also be set in the request." - name: "body" - type: "" - syntax: "public LastDetectResponse detectLastPoint(DetectRequest body)" - desc: "This operation generates a model using points before the latest one. With this method, only historical points are used to determine whether the target point is an anomaly. The latest point detecting operation matches the scenario of real-time monitoring of business metrics." + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + syntax: "public UnivariateLastDetectionResult detectUnivariateLastPoint(UnivariateDetectionOptions options)" + desc: "Detect anomaly status of the latest point in time series.\n\nThis operation generates a model using the points that you sent into the API, and based on all data to determine whether the last point is anomalous." returns: description: "the response of last anomaly detection." - type: "" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectLastPointWithResponse(com.azure.ai.anomalydetector.models.DetectRequest,com.azure.core.util.Context)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectLastPointWithResponse(DetectRequest body, Context context)" - name: "detectLastPointWithResponse(DetectRequest body, Context context)" - nameWithType: "AnomalyDetectorClient.detectLastPointWithResponse(DetectRequest body, Context context)" - summary: "This operation generates a model using points before the latest one." + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateLastPointWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.detectUnivariateLastPointWithResponse(BinaryData options, RequestOptions requestOptions)" + name: "detectUnivariateLastPointWithResponse(BinaryData options, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorClient.detectUnivariateLastPointWithResponse(BinaryData options, RequestOptions requestOptions)" + summary: "Detect anomaly status of the latest point in time series." parameters: - - description: "Time series points and period if needed. Advanced model parameters can also be set in the request." - name: "body" - type: "" - - description: "The context to associate with this operation." - name: "context" - type: "" - syntax: "public Response detectLastPointWithResponse(DetectRequest body, Context context)" - desc: "This operation generates a model using points before the latest one. With this method, only historical points are used to determine whether the target point is an anomaly. The latest point detecting operation matches the scenario of real-time monitoring of business metrics." + - description: "Method of univariate anomaly detection." + name: "options" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Response detectUnivariateLastPointWithResponse(BinaryData options, RequestOptions requestOptions)" + desc: "Detect anomaly status of the latest point in time series.\n\nThis operation generates a model using the points that you sent into the API, and based on all data to determine whether the last point is anomalous.\n\n**Request Body Schema**\n\n```java\n{\n series (Required): [\n (Required){\n timestamp: OffsetDateTime (Optional)\n value: double (Required)\n }\n ]\n granularity: String(yearly/monthly/weekly/daily/hourly/minutely/secondly/microsecond/none) (Optional)\n customInterval: Integer (Optional)\n period: Integer (Optional)\n maxAnomalyRatio: Double (Optional)\n sensitivity: Integer (Optional)\n imputeMode: String(auto/previous/linear/fixed/zero/notFill) (Optional)\n imputeFixedValue: Double (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n period: int (Required)\n suggestedWindow: int (Required)\n expectedValue: double (Required)\n upperMargin: double (Required)\n lowerMargin: double (Required)\n isAnomaly: boolean (Required)\n isNegativeAnomaly: boolean (Required)\n isPositiveAnomaly: boolean (Required)\n severity: Double (Optional)\n }\n```" returns: - description: "the response of last anomaly detection." - type: "<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.exportModel(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.exportModel(UUID modelId)" - name: "exportModel(UUID modelId)" - nameWithType: "AnomalyDetectorClient.exportModel(UUID modelId)" - summary: "Export multivariate anomaly detection model based on modelId." + description: "the response of last anomaly detection along with ." + type: "<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateBatchDetectionResult(java.lang.String)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateBatchDetectionResult(String resultId)" + name: "getMultivariateBatchDetectionResult(String resultId)" + nameWithType: "AnomalyDetectorClient.getMultivariateBatchDetectionResult(String resultId)" + summary: "Get Multivariate Anomaly Detection Result" parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - syntax: "public InputStream exportModel(UUID modelId)" - desc: "Export multivariate anomaly detection model based on modelId." - returns: - description: "the response." - type: "InputStream" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.exportModelWithResponse(java.util.UUID,com.azure.core.util.Context)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.exportModelWithResponse(UUID modelId, Context context)" - name: "exportModelWithResponse(UUID modelId, Context context)" - nameWithType: "AnomalyDetectorClient.exportModelWithResponse(UUID modelId, Context context)" - summary: "Export multivariate anomaly detection model based on modelId." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - - description: "The context to associate with this operation." - name: "context" - type: "" - syntax: "public StreamResponse exportModelWithResponse(UUID modelId, Context context)" - desc: "Export multivariate anomaly detection model based on modelId." - returns: - description: "the response." - type: "" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getDetectionResult(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getDetectionResult(UUID resultId)" - name: "getDetectionResult(UUID resultId)" - nameWithType: "AnomalyDetectorClient.getDetectionResult(UUID resultId)" - summary: "Get multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." - parameters: - - description: "Result identifier." + - description: "ID of a batch detection result." name: "resultId" - type: "UUID" - syntax: "public DetectionResult getDetectionResult(UUID resultId)" - desc: "Get multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." + type: "String" + syntax: "public MultivariateDetectionResult getMultivariateBatchDetectionResult(String resultId)" + desc: "Get Multivariate Anomaly Detection Result\n\nFor asynchronous inference, get multivariate anomaly detection result based on resultId returned by the BatchDetectAnomaly api." returns: - description: "multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." - type: "" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getDetectionResultWithResponse(java.util.UUID,com.azure.core.util.Context)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getDetectionResultWithResponse(UUID resultId, Context context)" - name: "getDetectionResultWithResponse(UUID resultId, Context context)" - nameWithType: "AnomalyDetectorClient.getDetectionResultWithResponse(UUID resultId, Context context)" - summary: "Get multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." + description: "detection results for the given resultId." + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateBatchDetectionResultWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateBatchDetectionResultWithResponse(String resultId, RequestOptions requestOptions)" + name: "getMultivariateBatchDetectionResultWithResponse(String resultId, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorClient.getMultivariateBatchDetectionResultWithResponse(String resultId, RequestOptions requestOptions)" + summary: "Get Multivariate Anomaly Detection Result" parameters: - - description: "Result identifier." + - description: "ID of a batch detection result." name: "resultId" - type: "UUID" - - description: "The context to associate with this operation." - name: "context" - type: "" - syntax: "public Response getDetectionResultWithResponse(UUID resultId, Context context)" - desc: "Get multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." + type: "String" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Response getMultivariateBatchDetectionResultWithResponse(String resultId, RequestOptions requestOptions)" + desc: "Get Multivariate Anomaly Detection Result\n\nFor asynchronous inference, get multivariate anomaly detection result based on resultId returned by the BatchDetectAnomaly api.\n\n**Response Body Schema**\n\n```java\n{\n resultId: String (Required)\n summary (Required): {\n status: String(CREATED/RUNNING/READY/FAILED) (Required)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n setupInfo (Required): {\n dataSource: String (Required)\n topContributorCount: int (Required)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n }\n }\n results (Required): [\n (Required){\n timestamp: OffsetDateTime (Required)\n value (Optional): {\n isAnomaly: boolean (Required)\n severity: double (Required)\n score: double (Required)\n interpretation (Optional): [\n (Optional){\n variable: String (Optional)\n contributionScore: Double (Optional)\n correlationChanges (Optional): {\n changedVariables (Optional): [\n String (Optional)\n ]\n }\n }\n ]\n }\n errors (Optional): [\n (recursive schema, see above)\n ]\n }\n ]\n }\n```" returns: - description: "multivariate anomaly detection result based on resultId returned by the DetectAnomalyAsync api." - type: "<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateModel(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateModel(UUID modelId)" - name: "getMultivariateModel(UUID modelId)" - nameWithType: "AnomalyDetectorClient.getMultivariateModel(UUID modelId)" - summary: "Get detailed information of multivariate model, including the training status and variables used in the model." + description: "detection results for the given resultId along with ." + type: "<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateModel(java.lang.String)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateModel(String modelId)" + name: "getMultivariateModel(String modelId)" + nameWithType: "AnomalyDetectorClient.getMultivariateModel(String modelId)" + summary: "Get Multivariate Model" parameters: - description: "Model identifier." name: "modelId" - type: "UUID" - syntax: "public Model getMultivariateModel(UUID modelId)" - desc: "Get detailed information of multivariate model, including the training status and variables used in the model." + type: "String" + syntax: "public AnomalyDetectionModel getMultivariateModel(String modelId)" + desc: "Get Multivariate Model\n\nGet detailed information of multivariate model, including the training status and variables used in the model." returns: description: "detailed information of multivariate model, including the training status and variables used in the\n model." - type: "" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateModelWithResponse(java.util.UUID,com.azure.core.util.Context)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateModelWithResponse(UUID modelId, Context context)" - name: "getMultivariateModelWithResponse(UUID modelId, Context context)" - nameWithType: "AnomalyDetectorClient.getMultivariateModelWithResponse(UUID modelId, Context context)" - summary: "Get detailed information of multivariate model, including the training status and variables used in the model." + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateModelWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.getMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + name: "getMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorClient.getMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + summary: "Get Multivariate Model" parameters: - description: "Model identifier." name: "modelId" - type: "UUID" - - description: "The context to associate with this operation." - name: "context" - type: "" - syntax: "public Response getMultivariateModelWithResponse(UUID modelId, Context context)" - desc: "Get detailed information of multivariate model, including the training status and variables used in the model." + type: "String" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Response getMultivariateModelWithResponse(String modelId, RequestOptions requestOptions)" + desc: "Get Multivariate Model\n\nGet detailed information of multivariate model, including the training status and variables used in the model.\n\n**Response Body Schema**\n\n```java\n{\n modelId: String (Required)\n createdTime: OffsetDateTime (Required)\n lastUpdatedTime: OffsetDateTime (Required)\n modelInfo (Optional): {\n dataSource: String (Required)\n dataSchema: String(OneTable/MultiTable) (Optional)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n displayName: String (Optional)\n slidingWindow: Integer (Optional)\n alignPolicy (Optional): {\n alignMode: String(Inner/Outer) (Optional)\n fillNAMethod: String(Previous/Subsequent/Linear/Zero/Fixed) (Optional)\n paddingValue: Double (Optional)\n }\n status: String(CREATED/RUNNING/READY/FAILED) (Optional)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n diagnosticsInfo (Optional): {\n modelState (Optional): {\n epochIds (Optional): [\n int (Optional)\n ]\n trainLosses (Optional): [\n double (Optional)\n ]\n validationLosses (Optional): [\n double (Optional)\n ]\n latenciesInSeconds (Optional): [\n double (Optional)\n ]\n }\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n }\n }\n }\n```" returns: - description: "detailed information of multivariate model, including the training status and variables used in the\n model." - type: "<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.lastDetectAnomaly(java.util.UUID,com.azure.ai.anomalydetector.models.LastDetectionRequest)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.lastDetectAnomaly(UUID modelId, LastDetectionRequest body)" - name: "lastDetectAnomaly(UUID modelId, LastDetectionRequest body)" - nameWithType: "AnomalyDetectorClient.lastDetectAnomaly(UUID modelId, LastDetectionRequest body)" - summary: "Synchronized API for anomaly detection." + description: "detailed information of multivariate model, including the training status and variables used in the model\n along with ." + type: "<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.listMultivariateModels()" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.listMultivariateModels()" + name: "listMultivariateModels()" + nameWithType: "AnomalyDetectorClient.listMultivariateModels()" + summary: "List Multivariate Models" + syntax: "public PagedIterable listMultivariateModels()" + desc: "List Multivariate Models\n\nList models of a resource." + returns: + description: "response of listing models as paginated response with ." + type: "<>" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.listMultivariateModels(com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.listMultivariateModels(RequestOptions requestOptions)" + name: "listMultivariateModels(RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorClient.listMultivariateModels(RequestOptions requestOptions)" + summary: "List Multivariate Models" parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - - description: "Request for last detection." - name: "body" - type: "" - syntax: "public LastDetectionResult lastDetectAnomaly(UUID modelId, LastDetectionRequest body)" - desc: "Synchronized API for anomaly detection." + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public PagedIterable listMultivariateModels(RequestOptions requestOptions)" + desc: "List Multivariate Models\n\nList models of a resource.\n\n**Query Parameters**\n\n | ---- | ------- | -------- | ----------------------------------------------- |\n | Name | Type | Required | Description |\n | skip | Integer | No | Skip indicates how many models will be skipped. |\n | top | Integer | No | Top indicates how many models will be fetched. |\n\nYou can add these to a request with \n\n**Response Body Schema**\n\n```java\n{\n modelId: String (Required)\n createdTime: OffsetDateTime (Required)\n lastUpdatedTime: OffsetDateTime (Required)\n modelInfo (Optional): {\n dataSource: String (Required)\n dataSchema: String(OneTable/MultiTable) (Optional)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n displayName: String (Optional)\n slidingWindow: Integer (Optional)\n alignPolicy (Optional): {\n alignMode: String(Inner/Outer) (Optional)\n fillNAMethod: String(Previous/Subsequent/Linear/Zero/Fixed) (Optional)\n paddingValue: Double (Optional)\n }\n status: String(CREATED/RUNNING/READY/FAILED) (Optional)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n diagnosticsInfo (Optional): {\n modelState (Optional): {\n epochIds (Optional): [\n int (Optional)\n ]\n trainLosses (Optional): [\n double (Optional)\n ]\n validationLosses (Optional): [\n double (Optional)\n ]\n latenciesInSeconds (Optional): [\n double (Optional)\n ]\n }\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n }\n }\n }\n```" returns: - description: "the response." - type: "" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.lastDetectAnomalyWithResponse(java.util.UUID,com.azure.ai.anomalydetector.models.LastDetectionRequest,com.azure.core.util.Context)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.lastDetectAnomalyWithResponse(UUID modelId, LastDetectionRequest body, Context context)" - name: "lastDetectAnomalyWithResponse(UUID modelId, LastDetectionRequest body, Context context)" - nameWithType: "AnomalyDetectorClient.lastDetectAnomalyWithResponse(UUID modelId, LastDetectionRequest body, Context context)" - summary: "Synchronized API for anomaly detection." - parameters: - - description: "Model identifier." - name: "modelId" - type: "UUID" - - description: "Request for last detection." - name: "body" - type: "" - - description: "The context to associate with this operation." - name: "context" - type: "" - syntax: "public Response lastDetectAnomalyWithResponse(UUID modelId, LastDetectionRequest body, Context context)" - desc: "Synchronized API for anomaly detection." - returns: - description: "the response." - type: "<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.listMultivariateModel(java.lang.Integer,java.lang.Integer)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.listMultivariateModel(Integer skip, Integer top)" - name: "listMultivariateModel(Integer skip, Integer top)" - nameWithType: "AnomalyDetectorClient.listMultivariateModel(Integer skip, Integer top)" - summary: "List models of a subscription." - parameters: - - description: "$skip indicates how many models will be skipped." - name: "skip" - type: "Integer" - - description: "$top indicates how many models will be fetched." - name: "top" - type: "Integer" - syntax: "public PagedIterable listMultivariateModel(Integer skip, Integer top)" - desc: "List models of a subscription." - returns: - description: "response of listing models." - type: "<>" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.listMultivariateModel(java.lang.Integer,java.lang.Integer,com.azure.core.util.Context)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.listMultivariateModel(Integer skip, Integer top, Context context)" - name: "listMultivariateModel(Integer skip, Integer top, Context context)" - nameWithType: "AnomalyDetectorClient.listMultivariateModel(Integer skip, Integer top, Context context)" - summary: "List models of a subscription." - parameters: - - description: "$skip indicates how many models will be skipped." - name: "skip" - type: "Integer" - - description: "$top indicates how many models will be fetched." - name: "top" - type: "Integer" - - description: "The context to associate with this operation." - name: "context" - type: "" - syntax: "public PagedIterable listMultivariateModel(Integer skip, Integer top, Context context)" - desc: "List models of a subscription." - returns: - description: "response of listing models." - type: "<>" + description: "response of listing models as paginated response with ." + type: "<>" - uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.trainMultivariateModel(com.azure.ai.anomalydetector.models.ModelInfo)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.trainMultivariateModel(ModelInfo body)" - name: "trainMultivariateModel(ModelInfo body)" - nameWithType: "AnomalyDetectorClient.trainMultivariateModel(ModelInfo body)" - summary: "Create and train a multivariate anomaly detection model." + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.trainMultivariateModel(ModelInfo modelInfo)" + name: "trainMultivariateModel(ModelInfo modelInfo)" + nameWithType: "AnomalyDetectorClient.trainMultivariateModel(ModelInfo modelInfo)" + summary: "Train a Multivariate Anomaly Detection Model" parameters: - - description: "Training request." - name: "body" + - description: "Model information." + name: "modelInfo" type: "" - syntax: "public void trainMultivariateModel(ModelInfo body)" - desc: "Create and train a multivariate anomaly detection model. The request must include a source parameter to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be in a single CSV file in which the first column is timestamp and the second column is value." -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.trainMultivariateModelWithResponse(com.azure.ai.anomalydetector.models.ModelInfo,com.azure.core.util.Context)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.trainMultivariateModelWithResponse(ModelInfo body, Context context)" - name: "trainMultivariateModelWithResponse(ModelInfo body, Context context)" - nameWithType: "AnomalyDetectorClient.trainMultivariateModelWithResponse(ModelInfo body, Context context)" - summary: "Create and train a multivariate anomaly detection model." - parameters: - - description: "Training request." - name: "body" - type: "" - - description: "The context to associate with this operation." - name: "context" - type: "" - syntax: "public TrainMultivariateModelResponse trainMultivariateModelWithResponse(ModelInfo body, Context context)" - desc: "Create and train a multivariate anomaly detection model. The request must include a source parameter to indicate an externally accessible Azure storage Uri (preferably a Shared Access Signature Uri). All time-series used in generate the model must be zipped into one single file. Each time-series will be in a single CSV file in which the first column is timestamp and the second column is value." + syntax: "public AnomalyDetectionModel trainMultivariateModel(ModelInfo modelInfo)" + desc: "Train a Multivariate Anomaly Detection Model\n\nCreate and train a multivariate anomaly detection model. The request must include a source parameter to indicate an externally accessible Azure blob storage URI.There are two types of data input: An URI pointed to an Azure blob storage folder which contains multiple CSV files, and each CSV file contains two columns, timestamp and variable. Another type of input is an URI pointed to a CSV file in Azure blob storage, which contains all the variables and a timestamp column." returns: - description: "the response." - type: "" + description: "response of getting a model." + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClient.trainMultivariateModelWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClient.trainMultivariateModelWithResponse(BinaryData modelInfo, RequestOptions requestOptions)" + name: "trainMultivariateModelWithResponse(BinaryData modelInfo, RequestOptions requestOptions)" + nameWithType: "AnomalyDetectorClient.trainMultivariateModelWithResponse(BinaryData modelInfo, RequestOptions requestOptions)" + summary: "Train a Multivariate Anomaly Detection Model" + parameters: + - description: "Model information." + name: "modelInfo" + type: "" + - description: "The options to configure the HTTP request before HTTP client sends it." + name: "requestOptions" + type: "" + syntax: "public Response trainMultivariateModelWithResponse(BinaryData modelInfo, RequestOptions requestOptions)" + desc: "Train a Multivariate Anomaly Detection Model\n\nCreate and train a multivariate anomaly detection model. The request must include a source parameter to indicate an externally accessible Azure blob storage URI.There are two types of data input: An URI pointed to an Azure blob storage folder which contains multiple CSV files, and each CSV file contains two columns, timestamp and variable. Another type of input is an URI pointed to a CSV file in Azure blob storage, which contains all the variables and a timestamp column.\n\n**Request Body Schema**\n\n```java\n{\n dataSource: String (Required)\n dataSchema: String(OneTable/MultiTable) (Optional)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n displayName: String (Optional)\n slidingWindow: Integer (Optional)\n alignPolicy (Optional): {\n alignMode: String(Inner/Outer) (Optional)\n fillNAMethod: String(Previous/Subsequent/Linear/Zero/Fixed) (Optional)\n paddingValue: Double (Optional)\n }\n status: String(CREATED/RUNNING/READY/FAILED) (Optional)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n diagnosticsInfo (Optional): {\n modelState (Optional): {\n epochIds (Optional): [\n int (Optional)\n ]\n trainLosses (Optional): [\n double (Optional)\n ]\n validationLosses (Optional): [\n double (Optional)\n ]\n latenciesInSeconds (Optional): [\n double (Optional)\n ]\n }\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n modelId: String (Required)\n createdTime: OffsetDateTime (Required)\n lastUpdatedTime: OffsetDateTime (Required)\n modelInfo (Optional): {\n dataSource: String (Required)\n dataSchema: String(OneTable/MultiTable) (Optional)\n startTime: OffsetDateTime (Required)\n endTime: OffsetDateTime (Required)\n displayName: String (Optional)\n slidingWindow: Integer (Optional)\n alignPolicy (Optional): {\n alignMode: String(Inner/Outer) (Optional)\n fillNAMethod: String(Previous/Subsequent/Linear/Zero/Fixed) (Optional)\n paddingValue: Double (Optional)\n }\n status: String(CREATED/RUNNING/READY/FAILED) (Optional)\n errors (Optional): [\n (Optional){\n code: String (Required)\n message: String (Required)\n }\n ]\n diagnosticsInfo (Optional): {\n modelState (Optional): {\n epochIds (Optional): [\n int (Optional)\n ]\n trainLosses (Optional): [\n double (Optional)\n ]\n validationLosses (Optional): [\n double (Optional)\n ]\n latenciesInSeconds (Optional): [\n double (Optional)\n ]\n }\n variableStates (Optional): [\n (Optional){\n variable: String (Optional)\n filledNARatio: Double (Optional)\n effectiveCount: Integer (Optional)\n firstTimestamp: OffsetDateTime (Optional)\n lastTimestamp: OffsetDateTime (Optional)\n }\n ]\n }\n }\n }\n```" + returns: + description: "response of getting a model along with ." + type: "<>" type: "class" desc: "Initializes a new instance of the synchronous AnomalyDetectorClient type." metadata: {} package: "com.azure.ai.anomalydetector" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.yml index 80e7b7b90edb..bba51ea9d956 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.yml @@ -20,7 +20,7 @@ inheritedClassMethods: - "wait" - "wait" - "wait" -syntax: "public final class **AnomalyDetectorClientBuilder**" +syntax: "public final class **AnomalyDetectorClientBuilder**
implements <>, <>, <>, <>" constructors: - uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.AnomalyDetectorClientBuilder()" fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.AnomalyDetectorClientBuilder()" @@ -34,37 +34,21 @@ methods: fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)" name: "addPolicy(HttpPipelinePolicy customPolicy)" nameWithType: "AnomalyDetectorClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)" - summary: "Adds a custom Http pipeline policy." + summary: "." parameters: - - description: "The custom Http pipeline policy to add." - name: "customPolicy" + - name: "customPolicy" type: "" syntax: "public AnomalyDetectorClientBuilder addPolicy(HttpPipelinePolicy customPolicy)" - desc: "Adds a custom Http pipeline policy." + desc: "." returns: - description: "the AnomalyDetectorClientBuilder." - type: "" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.apiVersion(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.apiVersion(String apiVersion)" - name: "apiVersion(String apiVersion)" - nameWithType: "AnomalyDetectorClientBuilder.apiVersion(String apiVersion)" - summary: "Sets Anomaly Detector API version (for example, v1.0)." - parameters: - - description: "the apiVersion value." - name: "apiVersion" - type: "String" - syntax: "public AnomalyDetectorClientBuilder apiVersion(String apiVersion)" - desc: "Sets Anomaly Detector API version (for example, v1.0)." - returns: - description: "the AnomalyDetectorClientBuilder." type: "" - uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.buildAsyncClient()" fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.buildAsyncClient()" name: "buildAsyncClient()" nameWithType: "AnomalyDetectorClientBuilder.buildAsyncClient()" - summary: "Builds an instance of AnomalyDetectorAsyncClient async client." + summary: "Builds an instance of AnomalyDetectorAsyncClient class." syntax: "public AnomalyDetectorAsyncClient buildAsyncClient()" - desc: "Builds an instance of AnomalyDetectorAsyncClient async client." + desc: "Builds an instance of AnomalyDetectorAsyncClient class." returns: description: "an instance of AnomalyDetectorAsyncClient." type: "" @@ -72,81 +56,107 @@ methods: fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.buildClient()" name: "buildClient()" nameWithType: "AnomalyDetectorClientBuilder.buildClient()" - summary: "Builds an instance of AnomalyDetectorClient sync client." + summary: "Builds an instance of AnomalyDetectorClient class." syntax: "public AnomalyDetectorClient buildClient()" - desc: "Builds an instance of AnomalyDetectorClient sync client." + desc: "Builds an instance of AnomalyDetectorClient class." returns: description: "an instance of AnomalyDetectorClient." type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.clientOptions(com.azure.core.util.ClientOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.clientOptions(ClientOptions clientOptions)" + name: "clientOptions(ClientOptions clientOptions)" + nameWithType: "AnomalyDetectorClientBuilder.clientOptions(ClientOptions clientOptions)" + summary: "." + parameters: + - name: "clientOptions" + type: "" + syntax: "public AnomalyDetectorClientBuilder clientOptions(ClientOptions clientOptions)" + desc: "." + returns: + type: "" - uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.configuration(com.azure.core.util.Configuration)" fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.configuration(Configuration configuration)" name: "configuration(Configuration configuration)" nameWithType: "AnomalyDetectorClientBuilder.configuration(Configuration configuration)" - summary: "Sets The configuration store that is used during construction of the service client." + summary: "." parameters: - - description: "the configuration value." - name: "configuration" + - name: "configuration" type: "" syntax: "public AnomalyDetectorClientBuilder configuration(Configuration configuration)" - desc: "Sets The configuration store that is used during construction of the service client." + desc: "." + returns: + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.credential(AzureKeyCredential azureKeyCredential)" + name: "credential(AzureKeyCredential azureKeyCredential)" + nameWithType: "AnomalyDetectorClientBuilder.credential(AzureKeyCredential azureKeyCredential)" + summary: "." + parameters: + - name: "azureKeyCredential" + type: "" + syntax: "public AnomalyDetectorClientBuilder credential(AzureKeyCredential azureKeyCredential)" + desc: "." returns: - description: "the AnomalyDetectorClientBuilder." type: "" - uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.endpoint(java.lang.String)" fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.endpoint(String endpoint)" name: "endpoint(String endpoint)" nameWithType: "AnomalyDetectorClientBuilder.endpoint(String endpoint)" - summary: "Sets Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com)." + summary: "." parameters: - - description: "the endpoint value." - name: "endpoint" + - name: "endpoint" type: "String" syntax: "public AnomalyDetectorClientBuilder endpoint(String endpoint)" - desc: "Sets Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com)." + desc: "." returns: - description: "the AnomalyDetectorClientBuilder." type: "" - uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.httpClient(com.azure.core.http.HttpClient)" fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.httpClient(HttpClient httpClient)" name: "httpClient(HttpClient httpClient)" nameWithType: "AnomalyDetectorClientBuilder.httpClient(HttpClient httpClient)" - summary: "Sets The HTTP client used to send the request." + summary: "." parameters: - - description: "the httpClient value." - name: "httpClient" + - name: "httpClient" type: "" syntax: "public AnomalyDetectorClientBuilder httpClient(HttpClient httpClient)" - desc: "Sets The HTTP client used to send the request." + desc: "." returns: - description: "the AnomalyDetectorClientBuilder." type: "" - uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)" fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)" name: "httpLogOptions(HttpLogOptions httpLogOptions)" nameWithType: "AnomalyDetectorClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)" - summary: "Sets The logging configuration for HTTP requests and responses." + summary: "." parameters: - - description: "the httpLogOptions value." - name: "httpLogOptions" + - name: "httpLogOptions" type: "" syntax: "public AnomalyDetectorClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)" - desc: "Sets The logging configuration for HTTP requests and responses." + desc: "." returns: - description: "the AnomalyDetectorClientBuilder." type: "" - uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.pipeline(com.azure.core.http.HttpPipeline)" fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.pipeline(HttpPipeline pipeline)" name: "pipeline(HttpPipeline pipeline)" nameWithType: "AnomalyDetectorClientBuilder.pipeline(HttpPipeline pipeline)" - summary: "Sets The HTTP pipeline to send requests through." + summary: "." parameters: - - description: "the pipeline value." - name: "pipeline" + - name: "pipeline" type: "" syntax: "public AnomalyDetectorClientBuilder pipeline(HttpPipeline pipeline)" - desc: "Sets The HTTP pipeline to send requests through." + desc: "." + returns: + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.retryOptions(RetryOptions retryOptions)" + name: "retryOptions(RetryOptions retryOptions)" + nameWithType: "AnomalyDetectorClientBuilder.retryOptions(RetryOptions retryOptions)" + summary: "." + parameters: + - name: "retryOptions" + type: "" + syntax: "public AnomalyDetectorClientBuilder retryOptions(RetryOptions retryOptions)" + desc: "." returns: - description: "the AnomalyDetectorClientBuilder." type: "" - uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)" fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.retryPolicy(RetryPolicy retryPolicy)" @@ -162,22 +172,27 @@ methods: returns: description: "the AnomalyDetectorClientBuilder." type: "" -- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.serializerAdapter(com.azure.core.util.serializer.SerializerAdapter)" - fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.serializerAdapter(SerializerAdapter serializerAdapter)" - name: "serializerAdapter(SerializerAdapter serializerAdapter)" - nameWithType: "AnomalyDetectorClientBuilder.serializerAdapter(SerializerAdapter serializerAdapter)" - summary: "Sets The serializer to serialize an object into a string." +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.serviceVersion(com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder.serviceVersion(AnomalyDetectorServiceVersion serviceVersion)" + name: "serviceVersion(AnomalyDetectorServiceVersion serviceVersion)" + nameWithType: "AnomalyDetectorClientBuilder.serviceVersion(AnomalyDetectorServiceVersion serviceVersion)" + summary: "Sets Service version." parameters: - - description: "the serializerAdapter value." - name: "serializerAdapter" - type: "" - syntax: "public AnomalyDetectorClientBuilder serializerAdapter(SerializerAdapter serializerAdapter)" - desc: "Sets The serializer to serialize an object into a string." + - description: "the serviceVersion value." + name: "serviceVersion" + type: "" + syntax: "public AnomalyDetectorClientBuilder serviceVersion(AnomalyDetectorServiceVersion serviceVersion)" + desc: "Sets Service version." returns: description: "the AnomalyDetectorClientBuilder." type: "" type: "class" desc: "A builder for creating a new instance of the AnomalyDetectorClient type." +implements: +- "<>" +- "<>" +- "<>" +- "<>" metadata: {} package: "com.azure.ai.anomalydetector" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.yml new file mode 100644 index 000000000000..640483c86cae --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.yml @@ -0,0 +1,85 @@ +### YamlMime:JavaEnum +uid: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion" +fullName: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion" +name: "AnomalyDetectorServiceVersion" +nameWithType: "AnomalyDetectorServiceVersion" +summary: "Service version of AnomalyDetectorClient." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "java.lang.Enum" + methodsRef: + - "valueOf-java.lang.Class-java.lang.String-\">valueOf" + - "clone" + - "compareTo" + - "equals" + - "finalize" + - "getDeclaringClass" + - "hashCode" + - "name" + - "ordinal" + - "toString" +- classRef: "java.lang.Object" + methodsRef: + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public enum **AnomalyDetectorServiceVersion**
extends Enum<>
implements " +fields: +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.V1_1" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.V1_1" + name: "V1_1" + nameWithType: "AnomalyDetectorServiceVersion.V1_1" + summary: "Enum value v1.1." + desc: "Enum value v1.1." +methods: +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.getLatest()" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.getLatest()" + name: "getLatest()" + nameWithType: "AnomalyDetectorServiceVersion.getLatest()" + summary: "Gets the latest service version supported by this client library." + modifiers: + - "static" + syntax: "public static AnomalyDetectorServiceVersion getLatest()" + desc: "Gets the latest service version supported by this client library." + returns: + description: "The latest ." + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.getVersion()" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.getVersion()" + name: "getVersion()" + nameWithType: "AnomalyDetectorServiceVersion.getVersion()" + syntax: "public String getVersion()" + returns: + type: "String" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.valueOf(java.lang.String)" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.valueOf(String name)" + name: "valueOf(String name)" + nameWithType: "AnomalyDetectorServiceVersion.valueOf(String name)" + modifiers: + - "static" + parameters: + - name: "name" + type: "String" + syntax: "public static AnomalyDetectorServiceVersion valueOf(String name)" + returns: + type: "" +- uid: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.values()" + fullName: "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion.values()" + name: "values()" + nameWithType: "AnomalyDetectorServiceVersion.values()" + modifiers: + - "static" + syntax: "public static AnomalyDetectorServiceVersion[] values()" + returns: + type: "[]" +desc: "Service version of AnomalyDetectorClient." +implements: +- "" +metadata: {} +package: "com.azure.ai.anomalydetector" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AlignMode.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AlignMode.yml index b557be952cdd..42ff1e552bcd 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AlignMode.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AlignMode.yml @@ -91,4 +91,4 @@ methods: desc: "Defines values for AlignMode." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AlignPolicy.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AlignPolicy.yml index 3ed3c087a517..44483b28b2c2 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AlignPolicy.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AlignPolicy.yml @@ -3,7 +3,7 @@ uid: "com.azure.ai.anomalydetector.models.AlignPolicy" fullName: "com.azure.ai.anomalydetector.models.AlignPolicy" name: "AlignPolicy" nameWithType: "AlignPolicy" -summary: "The AlignPolicy model." +summary: "An optional field, indicating the manner to align multiple variables." inheritances: - "" inheritedClassMethods: @@ -26,82 +26,84 @@ constructors: fullName: "com.azure.ai.anomalydetector.models.AlignPolicy.AlignPolicy()" name: "AlignPolicy()" nameWithType: "AlignPolicy.AlignPolicy()" + summary: "Creates an instance of AlignPolicy class." syntax: "public AlignPolicy()" + desc: "Creates an instance of AlignPolicy class." methods: - uid: "com.azure.ai.anomalydetector.models.AlignPolicy.getAlignMode()" fullName: "com.azure.ai.anomalydetector.models.AlignPolicy.getAlignMode()" name: "getAlignMode()" nameWithType: "AlignPolicy.getAlignMode()" - summary: "Get the alignMode property: An optional field, indicating how we align different variables to the same time-range." + summary: "Get the alignMode property: An optional field, indicating how to align different variables to the same time-range." syntax: "public AlignMode getAlignMode()" - desc: "Get the alignMode property: An optional field, indicating how we align different variables to the same time-range. Either Inner or Outer." + desc: "Get the alignMode property: An optional field, indicating how to align different variables to the same time-range. Either Inner or Outer." returns: description: "the alignMode value." type: "" -- uid: "com.azure.ai.anomalydetector.models.AlignPolicy.getFillNaMethod()" - fullName: "com.azure.ai.anomalydetector.models.AlignPolicy.getFillNaMethod()" - name: "getFillNaMethod()" - nameWithType: "AlignPolicy.getFillNaMethod()" - summary: "Get the fillNaMethod property: An optional field, indicating how missing values will be filled." - syntax: "public FillNaMethod getFillNaMethod()" - desc: "Get the fillNaMethod property: An optional field, indicating how missing values will be filled. One of Previous, Subsequent, Linear, Zero, Fixed, and NotFill. Cannot be set to NotFill, when the alignMode is Outer." +- uid: "com.azure.ai.anomalydetector.models.AlignPolicy.getFillNAMethod()" + fullName: "com.azure.ai.anomalydetector.models.AlignPolicy.getFillNAMethod()" + name: "getFillNAMethod()" + nameWithType: "AlignPolicy.getFillNAMethod()" + summary: "Get the fillNAMethod property: An optional field, indicating how missing values will be filled." + syntax: "public FillNAMethod getFillNAMethod()" + desc: "Get the fillNAMethod property: An optional field, indicating how missing values will be filled. One of Previous, Subsequent, Linear, Zero, Fixed." returns: - description: "the fillNaMethod value." - type: "" + description: "the fillNAMethod value." + type: "" - uid: "com.azure.ai.anomalydetector.models.AlignPolicy.getPaddingValue()" fullName: "com.azure.ai.anomalydetector.models.AlignPolicy.getPaddingValue()" name: "getPaddingValue()" nameWithType: "AlignPolicy.getPaddingValue()" summary: "Get the paddingValue property: An optional field." - syntax: "public Float getPaddingValue()" + syntax: "public Double getPaddingValue()" desc: "Get the paddingValue property: An optional field. Required when fillNAMethod is Fixed." returns: description: "the paddingValue value." - type: "Float" + type: "Double" - uid: "com.azure.ai.anomalydetector.models.AlignPolicy.setAlignMode(com.azure.ai.anomalydetector.models.AlignMode)" fullName: "com.azure.ai.anomalydetector.models.AlignPolicy.setAlignMode(AlignMode alignMode)" name: "setAlignMode(AlignMode alignMode)" nameWithType: "AlignPolicy.setAlignMode(AlignMode alignMode)" - summary: "Set the alignMode property: An optional field, indicating how we align different variables to the same time-range." + summary: "Set the alignMode property: An optional field, indicating how to align different variables to the same time-range." parameters: - description: "the alignMode value to set." name: "alignMode" type: "" syntax: "public AlignPolicy setAlignMode(AlignMode alignMode)" - desc: "Set the alignMode property: An optional field, indicating how we align different variables to the same time-range. Either Inner or Outer." + desc: "Set the alignMode property: An optional field, indicating how to align different variables to the same time-range. Either Inner or Outer." returns: description: "the AlignPolicy object itself." type: "" -- uid: "com.azure.ai.anomalydetector.models.AlignPolicy.setFillNaMethod(com.azure.ai.anomalydetector.models.FillNaMethod)" - fullName: "com.azure.ai.anomalydetector.models.AlignPolicy.setFillNaMethod(FillNaMethod fillNaMethod)" - name: "setFillNaMethod(FillNaMethod fillNaMethod)" - nameWithType: "AlignPolicy.setFillNaMethod(FillNaMethod fillNaMethod)" - summary: "Set the fillNaMethod property: An optional field, indicating how missing values will be filled." +- uid: "com.azure.ai.anomalydetector.models.AlignPolicy.setFillNAMethod(com.azure.ai.anomalydetector.models.FillNAMethod)" + fullName: "com.azure.ai.anomalydetector.models.AlignPolicy.setFillNAMethod(FillNAMethod fillNAMethod)" + name: "setFillNAMethod(FillNAMethod fillNAMethod)" + nameWithType: "AlignPolicy.setFillNAMethod(FillNAMethod fillNAMethod)" + summary: "Set the fillNAMethod property: An optional field, indicating how missing values will be filled." parameters: - - description: "the fillNaMethod value to set." - name: "fillNaMethod" - type: "" - syntax: "public AlignPolicy setFillNaMethod(FillNaMethod fillNaMethod)" - desc: "Set the fillNaMethod property: An optional field, indicating how missing values will be filled. One of Previous, Subsequent, Linear, Zero, Fixed, and NotFill. Cannot be set to NotFill, when the alignMode is Outer." + - description: "the fillNAMethod value to set." + name: "fillNAMethod" + type: "" + syntax: "public AlignPolicy setFillNAMethod(FillNAMethod fillNAMethod)" + desc: "Set the fillNAMethod property: An optional field, indicating how missing values will be filled. One of Previous, Subsequent, Linear, Zero, Fixed." returns: description: "the AlignPolicy object itself." type: "" -- uid: "com.azure.ai.anomalydetector.models.AlignPolicy.setPaddingValue(java.lang.Float)" - fullName: "com.azure.ai.anomalydetector.models.AlignPolicy.setPaddingValue(Float paddingValue)" - name: "setPaddingValue(Float paddingValue)" - nameWithType: "AlignPolicy.setPaddingValue(Float paddingValue)" +- uid: "com.azure.ai.anomalydetector.models.AlignPolicy.setPaddingValue(java.lang.Double)" + fullName: "com.azure.ai.anomalydetector.models.AlignPolicy.setPaddingValue(Double paddingValue)" + name: "setPaddingValue(Double paddingValue)" + nameWithType: "AlignPolicy.setPaddingValue(Double paddingValue)" summary: "Set the paddingValue property: An optional field." parameters: - description: "the paddingValue value to set." name: "paddingValue" - type: "Float" - syntax: "public AlignPolicy setPaddingValue(Float paddingValue)" + type: "Double" + syntax: "public AlignPolicy setPaddingValue(Double paddingValue)" desc: "Set the paddingValue property: An optional field. Required when fillNAMethod is Fixed." returns: description: "the AlignPolicy object itself." type: "" type: "class" -desc: "The AlignPolicy model." +desc: "An optional field, indicating the manner to align multiple variables." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectionModel.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectionModel.yml new file mode 100644 index 000000000000..3931618c2f8a --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectionModel.yml @@ -0,0 +1,69 @@ +### YamlMime:JavaType +uid: "com.azure.ai.anomalydetector.models.AnomalyDetectionModel" +fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectionModel" +name: "AnomalyDetectionModel" +nameWithType: "AnomalyDetectionModel" +summary: "Response of getting a model." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **AnomalyDetectionModel**" +methods: +- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectionModel.getCreatedTime()" + fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectionModel.getCreatedTime()" + name: "getCreatedTime()" + nameWithType: "AnomalyDetectionModel.getCreatedTime()" + summary: "Get the createdTime property: Date and time (UTC) when the model was created." + syntax: "public OffsetDateTime getCreatedTime()" + desc: "Get the createdTime property: Date and time (UTC) when the model was created." + returns: + description: "the createdTime value." + type: "OffsetDateTime" +- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectionModel.getLastUpdatedTime()" + fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectionModel.getLastUpdatedTime()" + name: "getLastUpdatedTime()" + nameWithType: "AnomalyDetectionModel.getLastUpdatedTime()" + summary: "Get the lastUpdatedTime property: Date and time (UTC) when the model was last updated." + syntax: "public OffsetDateTime getLastUpdatedTime()" + desc: "Get the lastUpdatedTime property: Date and time (UTC) when the model was last updated." + returns: + description: "the lastUpdatedTime value." + type: "OffsetDateTime" +- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectionModel.getModelId()" + fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectionModel.getModelId()" + name: "getModelId()" + nameWithType: "AnomalyDetectionModel.getModelId()" + summary: "Get the modelId property: Model identifier." + syntax: "public String getModelId()" + desc: "Get the modelId property: Model identifier." + returns: + description: "the modelId value." + type: "String" +- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectionModel.getModelInfo()" + fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectionModel.getModelInfo()" + name: "getModelInfo()" + nameWithType: "AnomalyDetectionModel.getModelInfo()" + summary: "Get the modelInfo property: Training result of a model including its status, errors and diagnostics information." + syntax: "public ModelInfo getModelInfo()" + desc: "Get the modelInfo property: Training result of a model including its status, errors and diagnostics information." + returns: + description: "the modelInfo value." + type: "" +type: "class" +desc: "Response of getting a model." +metadata: {} +package: "com.azure.ai.anomalydetector.models" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorError.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorError.yml deleted file mode 100644 index db132d32acaf..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorError.yml +++ /dev/null @@ -1,83 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorError" -fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorError" -name: "AnomalyDetectorError" -nameWithType: "AnomalyDetectorError" -summary: "Error information returned by the API." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **AnomalyDetectorError**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorError.AnomalyDetectorError()" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorError.AnomalyDetectorError()" - name: "AnomalyDetectorError()" - nameWithType: "AnomalyDetectorError.AnomalyDetectorError()" - syntax: "public AnomalyDetectorError()" -methods: -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorError.getCode()" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorError.getCode()" - name: "getCode()" - nameWithType: "AnomalyDetectorError.getCode()" - summary: "Get the code property: The error code." - syntax: "public AnomalyDetectorErrorCodes getCode()" - desc: "Get the code property: The error code." - returns: - description: "the code value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorError.getMessage()" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorError.getMessage()" - name: "getMessage()" - nameWithType: "AnomalyDetectorError.getMessage()" - summary: "Get the message property: A message explaining the error reported by the service." - syntax: "public String getMessage()" - desc: "Get the message property: A message explaining the error reported by the service." - returns: - description: "the message value." - type: "String" -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorError.setCode(com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorError.setCode(AnomalyDetectorErrorCodes code)" - name: "setCode(AnomalyDetectorErrorCodes code)" - nameWithType: "AnomalyDetectorError.setCode(AnomalyDetectorErrorCodes code)" - summary: "Set the code property: The error code." - parameters: - - description: "the code value to set." - name: "code" - type: "" - syntax: "public AnomalyDetectorError setCode(AnomalyDetectorErrorCodes code)" - desc: "Set the code property: The error code." - returns: - description: "the AnomalyDetectorError object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorError.setMessage(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorError.setMessage(String message)" - name: "setMessage(String message)" - nameWithType: "AnomalyDetectorError.setMessage(String message)" - summary: "Set the message property: A message explaining the error reported by the service." - parameters: - - description: "the message value to set." - name: "message" - type: "String" - syntax: "public AnomalyDetectorError setMessage(String message)" - desc: "Set the message property: A message explaining the error reported by the service." - returns: - description: "the AnomalyDetectorError object itself." - type: "" -type: "class" -desc: "Error information returned by the API." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.yml deleted file mode 100644 index 5641ccf38457..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.yml +++ /dev/null @@ -1,199 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes" -fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes" -name: "AnomalyDetectorErrorCodes" -nameWithType: "AnomalyDetectorErrorCodes" -summary: "Defines values for AnomalyDetectorErrorCodes." -inheritances: -- "" -- "" -inheritedClassMethods: -- classRef: "" - methodsRef: - - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" - - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" - - "" - - "" - - "" -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "finalize" - - "getClass" - - "notify" - - "notifyAll" - - "wait" - - "wait" - - "wait" -syntax: "public final class **AnomalyDetectorErrorCodes**
extends <>" -constructors: -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.AnomalyDetectorErrorCodes()" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.AnomalyDetectorErrorCodes()" - name: "AnomalyDetectorErrorCodes()" - nameWithType: "AnomalyDetectorErrorCodes.AnomalyDetectorErrorCodes()" - syntax: "public AnomalyDetectorErrorCodes()" -fields: -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.BAD_ARGUMENT" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.BAD_ARGUMENT" - name: "BAD_ARGUMENT" - nameWithType: "AnomalyDetectorErrorCodes.BAD_ARGUMENT" - summary: "Static value null for AnomalyDetectorErrorCodes." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final AnomalyDetectorErrorCodes BAD_ARGUMENT" - desc: "Static value null for AnomalyDetectorErrorCodes." -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_CUSTOM_INTERVAL" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_CUSTOM_INTERVAL" - name: "INVALID_CUSTOM_INTERVAL" - nameWithType: "AnomalyDetectorErrorCodes.INVALID_CUSTOM_INTERVAL" - summary: "Static value null for AnomalyDetectorErrorCodes." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final AnomalyDetectorErrorCodes INVALID_CUSTOM_INTERVAL" - desc: "Static value null for AnomalyDetectorErrorCodes." -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_GRANULARITY" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_GRANULARITY" - name: "INVALID_GRANULARITY" - nameWithType: "AnomalyDetectorErrorCodes.INVALID_GRANULARITY" - summary: "Static value null for AnomalyDetectorErrorCodes." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final AnomalyDetectorErrorCodes INVALID_GRANULARITY" - desc: "Static value null for AnomalyDetectorErrorCodes." -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_IMPUTE_FIXED_VALUE" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_IMPUTE_FIXED_VALUE" - name: "INVALID_IMPUTE_FIXED_VALUE" - nameWithType: "AnomalyDetectorErrorCodes.INVALID_IMPUTE_FIXED_VALUE" - summary: "Static value null for AnomalyDetectorErrorCodes." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final AnomalyDetectorErrorCodes INVALID_IMPUTE_FIXED_VALUE" - desc: "Static value null for AnomalyDetectorErrorCodes." -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_IMPUTE_MODE" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_IMPUTE_MODE" - name: "INVALID_IMPUTE_MODE" - nameWithType: "AnomalyDetectorErrorCodes.INVALID_IMPUTE_MODE" - summary: "Static value null for AnomalyDetectorErrorCodes." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final AnomalyDetectorErrorCodes INVALID_IMPUTE_MODE" - desc: "Static value null for AnomalyDetectorErrorCodes." -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_JSON_FORMAT" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_JSON_FORMAT" - name: "INVALID_JSON_FORMAT" - nameWithType: "AnomalyDetectorErrorCodes.INVALID_JSON_FORMAT" - summary: "Static value null for AnomalyDetectorErrorCodes." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final AnomalyDetectorErrorCodes INVALID_JSON_FORMAT" - desc: "Static value null for AnomalyDetectorErrorCodes." -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_MODEL_ARGUMENT" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_MODEL_ARGUMENT" - name: "INVALID_MODEL_ARGUMENT" - nameWithType: "AnomalyDetectorErrorCodes.INVALID_MODEL_ARGUMENT" - summary: "Static value null for AnomalyDetectorErrorCodes." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final AnomalyDetectorErrorCodes INVALID_MODEL_ARGUMENT" - desc: "Static value null for AnomalyDetectorErrorCodes." -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_PERIOD" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_PERIOD" - name: "INVALID_PERIOD" - nameWithType: "AnomalyDetectorErrorCodes.INVALID_PERIOD" - summary: "Static value null for AnomalyDetectorErrorCodes." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final AnomalyDetectorErrorCodes INVALID_PERIOD" - desc: "Static value null for AnomalyDetectorErrorCodes." -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_SERIES" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.INVALID_SERIES" - name: "INVALID_SERIES" - nameWithType: "AnomalyDetectorErrorCodes.INVALID_SERIES" - summary: "Static value null for AnomalyDetectorErrorCodes." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final AnomalyDetectorErrorCodes INVALID_SERIES" - desc: "Static value null for AnomalyDetectorErrorCodes." -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.REQUIRED_GRANULARITY" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.REQUIRED_GRANULARITY" - name: "REQUIRED_GRANULARITY" - nameWithType: "AnomalyDetectorErrorCodes.REQUIRED_GRANULARITY" - summary: "Static value null for AnomalyDetectorErrorCodes." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final AnomalyDetectorErrorCodes REQUIRED_GRANULARITY" - desc: "Static value null for AnomalyDetectorErrorCodes." -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.REQUIRED_SERIES" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.REQUIRED_SERIES" - name: "REQUIRED_SERIES" - nameWithType: "AnomalyDetectorErrorCodes.REQUIRED_SERIES" - summary: "Static value null for AnomalyDetectorErrorCodes." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final AnomalyDetectorErrorCodes REQUIRED_SERIES" - desc: "Static value null for AnomalyDetectorErrorCodes." -methods: -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.fromString(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.fromString(String name)" - name: "fromString(String name)" - nameWithType: "AnomalyDetectorErrorCodes.fromString(String name)" - summary: "Creates or finds a AnomalyDetectorErrorCodes from its string representation." - modifiers: - - "static" - parameters: - - description: "a name to look for." - name: "name" - type: "String" - syntax: "public static AnomalyDetectorErrorCodes fromString(String name)" - desc: "Creates or finds a AnomalyDetectorErrorCodes from its string representation." - returns: - description: "the corresponding AnomalyDetectorErrorCodes." - type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.values()" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes.values()" - name: "values()" - nameWithType: "AnomalyDetectorErrorCodes.values()" - modifiers: - - "static" - syntax: "public static Collection values()" - returns: - description: "known AnomalyDetectorErrorCodes values." - type: "Collection<>" -type: "class" -desc: "Defines values for AnomalyDetectorErrorCodes." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException.yml deleted file mode 100644 index fcd754d260f5..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException.yml +++ /dev/null @@ -1,92 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException" -fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException" -name: "AnomalyDetectorErrorException" -nameWithType: "AnomalyDetectorErrorException" -summary: "Exception thrown for an invalid response with AnomalyDetectorError information." -inheritances: -- "" -- "" -- "" -- "" -- "" -- "" -inheritedClassMethods: -- classRef: "" - methodsRef: - - "" - - "" -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "wait" - - "wait" - - "wait" -- classRef: "java.lang.Throwable" - methodsRef: - - "addSuppressed" - - "fillInStackTrace" - - "getCause" - - "getLocalizedMessage" - - "getMessage" - - "getStackTrace" - - "getSuppressed" - - "initCause" - - "printStackTrace" - - "printStackTrace" - - "printStackTrace" - - "setStackTrace" - - "toString" -syntax: "public final class **AnomalyDetectorErrorException**
extends " -constructors: -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException.AnomalyDetectorErrorException(java.lang.String,com.azure.core.http.HttpResponse)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException.AnomalyDetectorErrorException(String message, HttpResponse response)" - name: "AnomalyDetectorErrorException(String message, HttpResponse response)" - nameWithType: "AnomalyDetectorErrorException.AnomalyDetectorErrorException(String message, HttpResponse response)" - summary: "Initializes a new instance of the AnomalyDetectorErrorException class." - parameters: - - description: "the exception message or the response content if a message is not available." - name: "message" - type: "String" - - description: "the HTTP response." - name: "response" - type: "" - syntax: "public AnomalyDetectorErrorException(String message, HttpResponse response)" - desc: "Initializes a new instance of the AnomalyDetectorErrorException class." -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException.AnomalyDetectorErrorException(java.lang.String,com.azure.core.http.HttpResponse,com.azure.ai.anomalydetector.models.AnomalyDetectorError)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException.AnomalyDetectorErrorException(String message, HttpResponse response, AnomalyDetectorError value)" - name: "AnomalyDetectorErrorException(String message, HttpResponse response, AnomalyDetectorError value)" - nameWithType: "AnomalyDetectorErrorException.AnomalyDetectorErrorException(String message, HttpResponse response, AnomalyDetectorError value)" - summary: "Initializes a new instance of the AnomalyDetectorErrorException class." - parameters: - - description: "the exception message or the response content if a message is not available." - name: "message" - type: "String" - - description: "the HTTP response." - name: "response" - type: "" - - description: "the deserialized response value." - name: "value" - type: "" - syntax: "public AnomalyDetectorErrorException(String message, HttpResponse response, AnomalyDetectorError value)" - desc: "Initializes a new instance of the AnomalyDetectorErrorException class." -methods: -- uid: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException.getValue()" - fullName: "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException.getValue()" - name: "getValue()" - nameWithType: "AnomalyDetectorErrorException.getValue()" - overridden: "com.azure.core.exception.HttpResponseException.getValue()" - syntax: "public AnomalyDetectorError getValue()" - returns: - type: "" -type: "class" -desc: "Exception thrown for an invalid response with AnomalyDetectorError information." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyInterpretation.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyInterpretation.yml index a8e162b98339..ce8554ae403d 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyInterpretation.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyInterpretation.yml @@ -3,7 +3,7 @@ uid: "com.azure.ai.anomalydetector.models.AnomalyInterpretation" fullName: "com.azure.ai.anomalydetector.models.AnomalyInterpretation" name: "AnomalyInterpretation" nameWithType: "AnomalyInterpretation" -summary: "The AnomalyInterpretation model." +summary: "Interpretation of the anomalous timestamp." inheritances: - "" inheritedClassMethods: @@ -21,30 +21,24 @@ inheritedClassMethods: - "wait" - "wait" syntax: "public final class **AnomalyInterpretation**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.AnomalyInterpretation()" - fullName: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.AnomalyInterpretation()" - name: "AnomalyInterpretation()" - nameWithType: "AnomalyInterpretation.AnomalyInterpretation()" - syntax: "public AnomalyInterpretation()" methods: - uid: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.getContributionScore()" fullName: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.getContributionScore()" name: "getContributionScore()" nameWithType: "AnomalyInterpretation.getContributionScore()" - summary: "Get the contributionScore property: The contributionScore property." - syntax: "public Float getContributionScore()" - desc: "Get the contributionScore property: The contributionScore property." + summary: "Get the contributionScore property: This score shows the percentage contributing to the anomalous timestamp." + syntax: "public Double getContributionScore()" + desc: "Get the contributionScore property: This score shows the percentage contributing to the anomalous timestamp. A number between 0 and 1." returns: description: "the contributionScore value." - type: "Float" + type: "Double" - uid: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.getCorrelationChanges()" fullName: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.getCorrelationChanges()" name: "getCorrelationChanges()" nameWithType: "AnomalyInterpretation.getCorrelationChanges()" - summary: "Get the correlationChanges property: The correlationChanges property." + summary: "Get the correlationChanges property: Correlation changes among the anomalous variables." syntax: "public CorrelationChanges getCorrelationChanges()" - desc: "Get the correlationChanges property: The correlationChanges property." + desc: "Get the correlationChanges property: Correlation changes among the anomalous variables." returns: description: "the correlationChanges value." type: "" @@ -52,56 +46,14 @@ methods: fullName: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.getVariable()" name: "getVariable()" nameWithType: "AnomalyInterpretation.getVariable()" - summary: "Get the variable property: The variable property." + summary: "Get the variable property: Variable." syntax: "public String getVariable()" - desc: "Get the variable property: The variable property." + desc: "Get the variable property: Variable." returns: description: "the variable value." type: "String" -- uid: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.setContributionScore(java.lang.Float)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.setContributionScore(Float contributionScore)" - name: "setContributionScore(Float contributionScore)" - nameWithType: "AnomalyInterpretation.setContributionScore(Float contributionScore)" - summary: "Set the contributionScore property: The contributionScore property." - parameters: - - description: "the contributionScore value to set." - name: "contributionScore" - type: "Float" - syntax: "public AnomalyInterpretation setContributionScore(Float contributionScore)" - desc: "Set the contributionScore property: The contributionScore property." - returns: - description: "the AnomalyInterpretation object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.setCorrelationChanges(com.azure.ai.anomalydetector.models.CorrelationChanges)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.setCorrelationChanges(CorrelationChanges correlationChanges)" - name: "setCorrelationChanges(CorrelationChanges correlationChanges)" - nameWithType: "AnomalyInterpretation.setCorrelationChanges(CorrelationChanges correlationChanges)" - summary: "Set the correlationChanges property: The correlationChanges property." - parameters: - - description: "the correlationChanges value to set." - name: "correlationChanges" - type: "" - syntax: "public AnomalyInterpretation setCorrelationChanges(CorrelationChanges correlationChanges)" - desc: "Set the correlationChanges property: The correlationChanges property." - returns: - description: "the AnomalyInterpretation object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.setVariable(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyInterpretation.setVariable(String variable)" - name: "setVariable(String variable)" - nameWithType: "AnomalyInterpretation.setVariable(String variable)" - summary: "Set the variable property: The variable property." - parameters: - - description: "the variable value to set." - name: "variable" - type: "String" - syntax: "public AnomalyInterpretation setVariable(String variable)" - desc: "Set the variable property: The variable property." - returns: - description: "the AnomalyInterpretation object itself." - type: "" type: "class" -desc: "The AnomalyInterpretation model." +desc: "Interpretation of the anomalous timestamp." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyState.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyState.yml index 35ea3ec312cd..b21d5e432e7a 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyState.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyState.yml @@ -3,7 +3,7 @@ uid: "com.azure.ai.anomalydetector.models.AnomalyState" fullName: "com.azure.ai.anomalydetector.models.AnomalyState" name: "AnomalyState" nameWithType: "AnomalyState" -summary: "The AnomalyState model." +summary: "Anomaly status and information." inheritances: - "" inheritedClassMethods: @@ -21,12 +21,6 @@ inheritedClassMethods: - "wait" - "wait" syntax: "public final class **AnomalyState**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.AnomalyState.AnomalyState()" - fullName: "com.azure.ai.anomalydetector.models.AnomalyState.AnomalyState()" - name: "AnomalyState()" - nameWithType: "AnomalyState.AnomalyState()" - syntax: "public AnomalyState()" methods: - uid: "com.azure.ai.anomalydetector.models.AnomalyState.getErrors()" fullName: "com.azure.ai.anomalydetector.models.AnomalyState.getErrors()" @@ -42,9 +36,9 @@ methods: fullName: "com.azure.ai.anomalydetector.models.AnomalyState.getTimestamp()" name: "getTimestamp()" nameWithType: "AnomalyState.getTimestamp()" - summary: "Get the timestamp property: timestamp." + summary: "Get the timestamp property: The timestamp for this anomaly." syntax: "public OffsetDateTime getTimestamp()" - desc: "Get the timestamp property: timestamp." + desc: "Get the timestamp property: The timestamp for this anomaly." returns: description: "the timestamp value." type: "OffsetDateTime" @@ -52,56 +46,14 @@ methods: fullName: "com.azure.ai.anomalydetector.models.AnomalyState.getValue()" name: "getValue()" nameWithType: "AnomalyState.getValue()" - summary: "Get the value property: The value property." + summary: "Get the value property: The detailed value of this anomalous timestamp." syntax: "public AnomalyValue getValue()" - desc: "Get the value property: The value property." + desc: "Get the value property: The detailed value of this anomalous timestamp." returns: description: "the value value." type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyState.setErrors(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyState.setErrors(List errors)" - name: "setErrors(List errors)" - nameWithType: "AnomalyState.setErrors(List errors)" - summary: "Set the errors property: Error message for the current timestamp." - parameters: - - description: "the errors value to set." - name: "errors" - type: "List<>" - syntax: "public AnomalyState setErrors(List errors)" - desc: "Set the errors property: Error message for the current timestamp." - returns: - description: "the AnomalyState object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyState.setTimestamp(java.time.OffsetDateTime)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyState.setTimestamp(OffsetDateTime timestamp)" - name: "setTimestamp(OffsetDateTime timestamp)" - nameWithType: "AnomalyState.setTimestamp(OffsetDateTime timestamp)" - summary: "Set the timestamp property: timestamp." - parameters: - - description: "the timestamp value to set." - name: "timestamp" - type: "OffsetDateTime" - syntax: "public AnomalyState setTimestamp(OffsetDateTime timestamp)" - desc: "Set the timestamp property: timestamp." - returns: - description: "the AnomalyState object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyState.setValue(com.azure.ai.anomalydetector.models.AnomalyValue)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyState.setValue(AnomalyValue value)" - name: "setValue(AnomalyValue value)" - nameWithType: "AnomalyState.setValue(AnomalyValue value)" - summary: "Set the value property: The value property." - parameters: - - description: "the value value to set." - name: "value" - type: "" - syntax: "public AnomalyState setValue(AnomalyValue value)" - desc: "Set the value property: The value property." - returns: - description: "the AnomalyState object itself." - type: "" type: "class" -desc: "The AnomalyState model." +desc: "Anomaly status and information." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyValue.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyValue.yml index 6f4679c1b29e..5fea16faebdb 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyValue.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.AnomalyValue.yml @@ -3,7 +3,7 @@ uid: "com.azure.ai.anomalydetector.models.AnomalyValue" fullName: "com.azure.ai.anomalydetector.models.AnomalyValue" name: "AnomalyValue" nameWithType: "AnomalyValue" -summary: "The AnomalyValue model." +summary: "Detailed information of the anomalous timestamp." inheritances: - "" inheritedClassMethods: @@ -21,20 +21,14 @@ inheritedClassMethods: - "wait" - "wait" syntax: "public final class **AnomalyValue**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.AnomalyValue.AnomalyValue()" - fullName: "com.azure.ai.anomalydetector.models.AnomalyValue.AnomalyValue()" - name: "AnomalyValue()" - nameWithType: "AnomalyValue.AnomalyValue()" - syntax: "public AnomalyValue()" methods: - uid: "com.azure.ai.anomalydetector.models.AnomalyValue.getInterpretation()" fullName: "com.azure.ai.anomalydetector.models.AnomalyValue.getInterpretation()" name: "getInterpretation()" nameWithType: "AnomalyValue.getInterpretation()" - summary: "Get the interpretation property: The interpretation property." + summary: "Get the interpretation property: Interpretation of this anomalous timestamp." syntax: "public List getInterpretation()" - desc: "Get the interpretation property: The interpretation property." + desc: "Get the interpretation property: Interpretation of this anomalous timestamp." returns: description: "the interpretation value." type: "List<>" @@ -42,22 +36,22 @@ methods: fullName: "com.azure.ai.anomalydetector.models.AnomalyValue.getScore()" name: "getScore()" nameWithType: "AnomalyValue.getScore()" - summary: "Get the score property: Raw score from the model." - syntax: "public float getScore()" - desc: "Get the score property: Raw score from the model." + summary: "Get the score property: Raw anomaly score of severity, will help indicate the degree of abnormality as well." + syntax: "public double getScore()" + desc: "Get the score property: Raw anomaly score of severity, will help indicate the degree of abnormality as well." returns: description: "the score value." - type: "" + type: "" - uid: "com.azure.ai.anomalydetector.models.AnomalyValue.getSeverity()" fullName: "com.azure.ai.anomalydetector.models.AnomalyValue.getSeverity()" name: "getSeverity()" nameWithType: "AnomalyValue.getSeverity()" summary: "Get the severity property: Indicates the significance of the anomaly." - syntax: "public float getSeverity()" - desc: "Get the severity property: Indicates the significance of the anomaly. The higher the severity, the more significant the anomaly." + syntax: "public double getSeverity()" + desc: "Get the severity property: Indicates the significance of the anomaly. The higher the severity, the more significant the anomaly is." returns: description: "the severity value." - type: "" + type: "" - uid: "com.azure.ai.anomalydetector.models.AnomalyValue.isAnomaly()" fullName: "com.azure.ai.anomalydetector.models.AnomalyValue.isAnomaly()" name: "isAnomaly()" @@ -68,64 +62,8 @@ methods: returns: description: "the isAnomaly value." type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyValue.setInterpretation(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyValue.setInterpretation(List interpretation)" - name: "setInterpretation(List interpretation)" - nameWithType: "AnomalyValue.setInterpretation(List interpretation)" - summary: "Set the interpretation property: The interpretation property." - parameters: - - description: "the interpretation value to set." - name: "interpretation" - type: "List<>" - syntax: "public AnomalyValue setInterpretation(List interpretation)" - desc: "Set the interpretation property: The interpretation property." - returns: - description: "the AnomalyValue object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyValue.setIsAnomaly(boolean)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyValue.setIsAnomaly(boolean isAnomaly)" - name: "setIsAnomaly(boolean isAnomaly)" - nameWithType: "AnomalyValue.setIsAnomaly(boolean isAnomaly)" - summary: "Set the isAnomaly property: True if an anomaly is detected at the current timestamp." - parameters: - - description: "the isAnomaly value to set." - name: "isAnomaly" - type: "" - syntax: "public AnomalyValue setIsAnomaly(boolean isAnomaly)" - desc: "Set the isAnomaly property: True if an anomaly is detected at the current timestamp." - returns: - description: "the AnomalyValue object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyValue.setScore(float)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyValue.setScore(float score)" - name: "setScore(float score)" - nameWithType: "AnomalyValue.setScore(float score)" - summary: "Set the score property: Raw score from the model." - parameters: - - description: "the score value to set." - name: "score" - type: "" - syntax: "public AnomalyValue setScore(float score)" - desc: "Set the score property: Raw score from the model." - returns: - description: "the AnomalyValue object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.AnomalyValue.setSeverity(float)" - fullName: "com.azure.ai.anomalydetector.models.AnomalyValue.setSeverity(float severity)" - name: "setSeverity(float severity)" - nameWithType: "AnomalyValue.setSeverity(float severity)" - summary: "Set the severity property: Indicates the significance of the anomaly." - parameters: - - description: "the severity value to set." - name: "severity" - type: "" - syntax: "public AnomalyValue setSeverity(float severity)" - desc: "Set the severity property: Indicates the significance of the anomaly. The higher the severity, the more significant the anomaly." - returns: - description: "the AnomalyValue object itself." - type: "" type: "class" -desc: "The AnomalyValue model." +desc: "Detailed information of the anomalous timestamp." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ChangePointDetectResponse.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ChangePointDetectResponse.yml deleted file mode 100644 index 3023d88254f2..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ChangePointDetectResponse.yml +++ /dev/null @@ -1,93 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse" -fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse" -name: "ChangePointDetectResponse" -nameWithType: "ChangePointDetectResponse" -summary: "The response of change point detection." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **ChangePointDetectResponse**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.ChangePointDetectResponse()" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.ChangePointDetectResponse()" - name: "ChangePointDetectResponse()" - nameWithType: "ChangePointDetectResponse.ChangePointDetectResponse()" - syntax: "public ChangePointDetectResponse()" -methods: -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.getConfidenceScores()" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.getConfidenceScores()" - name: "getConfidenceScores()" - nameWithType: "ChangePointDetectResponse.getConfidenceScores()" - summary: "Get the confidenceScores property: the change point confidence of each point." - syntax: "public List getConfidenceScores()" - desc: "Get the confidenceScores property: the change point confidence of each point." - returns: - description: "the confidenceScores value." - type: "List<Float>" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.getIsChangePoint()" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.getIsChangePoint()" - name: "getIsChangePoint()" - nameWithType: "ChangePointDetectResponse.getIsChangePoint()" - summary: "Get the isChangePoint property: isChangePoint contains change point properties for each input point." - syntax: "public List getIsChangePoint()" - desc: "Get the isChangePoint property: isChangePoint contains change point properties for each input point. True means an anomaly either negative or positive has been detected. The index of the array is consistent with the input series." - returns: - description: "the isChangePoint value." - type: "List<Boolean>" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.getPeriod()" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.getPeriod()" - name: "getPeriod()" - nameWithType: "ChangePointDetectResponse.getPeriod()" - summary: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." - syntax: "public Integer getPeriod()" - desc: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." - returns: - description: "the period value." - type: "Integer" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.setConfidenceScores(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.setConfidenceScores(List confidenceScores)" - name: "setConfidenceScores(List confidenceScores)" - nameWithType: "ChangePointDetectResponse.setConfidenceScores(List confidenceScores)" - summary: "Set the confidenceScores property: the change point confidence of each point." - parameters: - - description: "the confidenceScores value to set." - name: "confidenceScores" - type: "List<Float>" - syntax: "public ChangePointDetectResponse setConfidenceScores(List confidenceScores)" - desc: "Set the confidenceScores property: the change point confidence of each point." - returns: - description: "the ChangePointDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.setIsChangePoint(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectResponse.setIsChangePoint(List isChangePoint)" - name: "setIsChangePoint(List isChangePoint)" - nameWithType: "ChangePointDetectResponse.setIsChangePoint(List isChangePoint)" - summary: "Set the isChangePoint property: isChangePoint contains change point properties for each input point." - parameters: - - description: "the isChangePoint value to set." - name: "isChangePoint" - type: "List<Boolean>" - syntax: "public ChangePointDetectResponse setIsChangePoint(List isChangePoint)" - desc: "Set the isChangePoint property: isChangePoint contains change point properties for each input point. True means an anomaly either negative or positive has been detected. The index of the array is consistent with the input series." - returns: - description: "the ChangePointDetectResponse object itself." - type: "" -type: "class" -desc: "The response of change point detection." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.CorrelationChanges.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.CorrelationChanges.yml index d987aa6195a8..5e957fa60625 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.CorrelationChanges.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.CorrelationChanges.yml @@ -3,7 +3,7 @@ uid: "com.azure.ai.anomalydetector.models.CorrelationChanges" fullName: "com.azure.ai.anomalydetector.models.CorrelationChanges" name: "CorrelationChanges" nameWithType: "CorrelationChanges" -summary: "The CorrelationChanges model." +summary: "Correlation changes among the anomalous variables." inheritances: - "" inheritedClassMethods: @@ -21,63 +21,19 @@ inheritedClassMethods: - "wait" - "wait" syntax: "public final class **CorrelationChanges**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.CorrelationChanges.CorrelationChanges()" - fullName: "com.azure.ai.anomalydetector.models.CorrelationChanges.CorrelationChanges()" - name: "CorrelationChanges()" - nameWithType: "CorrelationChanges.CorrelationChanges()" - syntax: "public CorrelationChanges()" methods: -- uid: "com.azure.ai.anomalydetector.models.CorrelationChanges.getChangedValues()" - fullName: "com.azure.ai.anomalydetector.models.CorrelationChanges.getChangedValues()" - name: "getChangedValues()" - nameWithType: "CorrelationChanges.getChangedValues()" - summary: "Get the changedValues property: changes in correlation." - syntax: "public List getChangedValues()" - desc: "Get the changedValues property: changes in correlation." - returns: - description: "the changedValues value." - type: "List<Float>" - uid: "com.azure.ai.anomalydetector.models.CorrelationChanges.getChangedVariables()" fullName: "com.azure.ai.anomalydetector.models.CorrelationChanges.getChangedVariables()" name: "getChangedVariables()" nameWithType: "CorrelationChanges.getChangedVariables()" - summary: "Get the changedVariables property: correlated variables." + summary: "Get the changedVariables property: The correlated variables that have correlation changes under an anomaly." syntax: "public List getChangedVariables()" - desc: "Get the changedVariables property: correlated variables." + desc: "Get the changedVariables property: The correlated variables that have correlation changes under an anomaly." returns: description: "the changedVariables value." type: "List<String>" -- uid: "com.azure.ai.anomalydetector.models.CorrelationChanges.setChangedValues(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.CorrelationChanges.setChangedValues(List changedValues)" - name: "setChangedValues(List changedValues)" - nameWithType: "CorrelationChanges.setChangedValues(List changedValues)" - summary: "Set the changedValues property: changes in correlation." - parameters: - - description: "the changedValues value to set." - name: "changedValues" - type: "List<Float>" - syntax: "public CorrelationChanges setChangedValues(List changedValues)" - desc: "Set the changedValues property: changes in correlation." - returns: - description: "the CorrelationChanges object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.CorrelationChanges.setChangedVariables(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.CorrelationChanges.setChangedVariables(List changedVariables)" - name: "setChangedVariables(List changedVariables)" - nameWithType: "CorrelationChanges.setChangedVariables(List changedVariables)" - summary: "Set the changedVariables property: correlated variables." - parameters: - - description: "the changedVariables value to set." - name: "changedVariables" - type: "List<String>" - syntax: "public CorrelationChanges setChangedVariables(List changedVariables)" - desc: "Set the changedVariables property: correlated variables." - returns: - description: "the CorrelationChanges object itself." - type: "" type: "class" -desc: "The CorrelationChanges model." +desc: "Correlation changes among the anomalous variables." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DataSchema.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DataSchema.yml new file mode 100644 index 000000000000..3526933f2ab9 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DataSchema.yml @@ -0,0 +1,93 @@ +### YamlMime:JavaType +uid: "com.azure.ai.anomalydetector.models.DataSchema" +fullName: "com.azure.ai.anomalydetector.models.DataSchema" +name: "DataSchema" +nameWithType: "DataSchema" +summary: "Defines values for DataSchema." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "" + methodsRef: + - "fromString(java.lang.String,java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.fromString&text=fromString\" data-throw-if-not-resolved=\"False\" />" + - "values(java.lang.Class)?alt=com.azure.core.util.ExpandableStringEnum.values&text=values\" data-throw-if-not-resolved=\"False\" />" + - "" + - "" + - "" +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "finalize" + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public final class **DataSchema**
extends <>" +constructors: +- uid: "com.azure.ai.anomalydetector.models.DataSchema.DataSchema()" + fullName: "com.azure.ai.anomalydetector.models.DataSchema.DataSchema()" + name: "DataSchema()" + nameWithType: "DataSchema.DataSchema()" + syntax: "public DataSchema()" +fields: +- uid: "com.azure.ai.anomalydetector.models.DataSchema.MULTI_TABLE" + fullName: "com.azure.ai.anomalydetector.models.DataSchema.MULTI_TABLE" + name: "MULTI_TABLE" + nameWithType: "DataSchema.MULTI_TABLE" + summary: "Static value MultiTable for DataSchema." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DataSchema MULTI_TABLE" + desc: "Static value MultiTable for DataSchema." +- uid: "com.azure.ai.anomalydetector.models.DataSchema.ONE_TABLE" + fullName: "com.azure.ai.anomalydetector.models.DataSchema.ONE_TABLE" + name: "ONE_TABLE" + nameWithType: "DataSchema.ONE_TABLE" + summary: "Static value OneTable for DataSchema." + modifiers: + - "static" + - "final" + field: + type: "" + syntax: "public static final DataSchema ONE_TABLE" + desc: "Static value OneTable for DataSchema." +methods: +- uid: "com.azure.ai.anomalydetector.models.DataSchema.fromString(java.lang.String)" + fullName: "com.azure.ai.anomalydetector.models.DataSchema.fromString(String name)" + name: "fromString(String name)" + nameWithType: "DataSchema.fromString(String name)" + summary: "Creates or finds a DataSchema from its string representation." + modifiers: + - "static" + parameters: + - description: "a name to look for." + name: "name" + type: "String" + syntax: "public static DataSchema fromString(String name)" + desc: "Creates or finds a DataSchema from its string representation." + returns: + description: "the corresponding DataSchema." + type: "" +- uid: "com.azure.ai.anomalydetector.models.DataSchema.values()" + fullName: "com.azure.ai.anomalydetector.models.DataSchema.values()" + name: "values()" + nameWithType: "DataSchema.values()" + summary: "Gets known DataSchema values." + modifiers: + - "static" + syntax: "public static Collection values()" + desc: "Gets known DataSchema values." + returns: + description: "known DataSchema values." + type: "Collection<>" +type: "class" +desc: "Defines values for DataSchema." +metadata: {} +package: "com.azure.ai.anomalydetector.models" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectAnomalyHeaders.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectAnomalyHeaders.yml deleted file mode 100644 index 5be83585b69a..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectAnomalyHeaders.yml +++ /dev/null @@ -1,59 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.DetectAnomalyHeaders" -fullName: "com.azure.ai.anomalydetector.models.DetectAnomalyHeaders" -name: "DetectAnomalyHeaders" -nameWithType: "DetectAnomalyHeaders" -summary: "The DetectAnomalyHeaders model." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **DetectAnomalyHeaders**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.DetectAnomalyHeaders.DetectAnomalyHeaders()" - fullName: "com.azure.ai.anomalydetector.models.DetectAnomalyHeaders.DetectAnomalyHeaders()" - name: "DetectAnomalyHeaders()" - nameWithType: "DetectAnomalyHeaders.DetectAnomalyHeaders()" - syntax: "public DetectAnomalyHeaders()" -methods: -- uid: "com.azure.ai.anomalydetector.models.DetectAnomalyHeaders.getLocation()" - fullName: "com.azure.ai.anomalydetector.models.DetectAnomalyHeaders.getLocation()" - name: "getLocation()" - nameWithType: "DetectAnomalyHeaders.getLocation()" - summary: "Get the location property: The Location property." - syntax: "public String getLocation()" - desc: "Get the location property: The Location property." - returns: - description: "the location value." - type: "String" -- uid: "com.azure.ai.anomalydetector.models.DetectAnomalyHeaders.setLocation(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.DetectAnomalyHeaders.setLocation(String location)" - name: "setLocation(String location)" - nameWithType: "DetectAnomalyHeaders.setLocation(String location)" - summary: "Set the location property: The Location property." - parameters: - - description: "the location value to set." - name: "location" - type: "String" - syntax: "public DetectAnomalyHeaders setLocation(String location)" - desc: "Set the location property: The Location property." - returns: - description: "the DetectAnomalyHeaders object itself." - type: "" -type: "class" -desc: "The DetectAnomalyHeaders model." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectAnomalyResponse.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectAnomalyResponse.yml deleted file mode 100644 index f63f8517518d..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectAnomalyResponse.yml +++ /dev/null @@ -1,60 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.DetectAnomalyResponse" -fullName: "com.azure.ai.anomalydetector.models.DetectAnomalyResponse" -name: "DetectAnomalyResponse" -nameWithType: "DetectAnomalyResponse" -summary: "Contains all response data for the detectAnomaly operation." -inheritances: -- "" -- "" -inheritedClassMethods: -- classRef: "" - methodsRef: - - "" - - "" - - "" - - "" - - "" -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **DetectAnomalyResponse**
extends <,Void>" -constructors: -- uid: "com.azure.ai.anomalydetector.models.DetectAnomalyResponse.DetectAnomalyResponse(com.azure.core.http.HttpRequest,int,com.azure.core.http.HttpHeaders,java.lang.Void,com.azure.ai.anomalydetector.models.DetectAnomalyHeaders)" - fullName: "com.azure.ai.anomalydetector.models.DetectAnomalyResponse.DetectAnomalyResponse(HttpRequest request, int statusCode, HttpHeaders rawHeaders, Void value, DetectAnomalyHeaders headers)" - name: "DetectAnomalyResponse(HttpRequest request, int statusCode, HttpHeaders rawHeaders, Void value, DetectAnomalyHeaders headers)" - nameWithType: "DetectAnomalyResponse.DetectAnomalyResponse(HttpRequest request, int statusCode, HttpHeaders rawHeaders, Void value, DetectAnomalyHeaders headers)" - summary: "Creates an instance of DetectAnomalyResponse." - parameters: - - description: "the request which resulted in this DetectAnomalyResponse." - name: "request" - type: "" - - description: "the status code of the HTTP response." - name: "statusCode" - type: "" - - description: "the raw headers of the HTTP response." - name: "rawHeaders" - type: "" - - description: "the deserialized value of the HTTP response." - name: "value" - type: "Void" - - description: "the deserialized headers of the HTTP response." - name: "headers" - type: "" - syntax: "public DetectAnomalyResponse(HttpRequest request, int statusCode, HttpHeaders rawHeaders, Void value, DetectAnomalyHeaders headers)" - desc: "Creates an instance of DetectAnomalyResponse." -type: "class" -desc: "Contains all response data for the detectAnomaly operation." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionRequest.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionRequest.yml deleted file mode 100644 index 6d8614307b51..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionRequest.yml +++ /dev/null @@ -1,107 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.DetectionRequest" -fullName: "com.azure.ai.anomalydetector.models.DetectionRequest" -name: "DetectionRequest" -nameWithType: "DetectionRequest" -summary: "Detection request." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **DetectionRequest**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.DetectionRequest.DetectionRequest()" - fullName: "com.azure.ai.anomalydetector.models.DetectionRequest.DetectionRequest()" - name: "DetectionRequest()" - nameWithType: "DetectionRequest.DetectionRequest()" - syntax: "public DetectionRequest()" -methods: -- uid: "com.azure.ai.anomalydetector.models.DetectionRequest.getEndTime()" - fullName: "com.azure.ai.anomalydetector.models.DetectionRequest.getEndTime()" - name: "getEndTime()" - nameWithType: "DetectionRequest.getEndTime()" - summary: "Get the endTime property: A required field, indicating the end time of data for detection." - syntax: "public OffsetDateTime getEndTime()" - desc: "Get the endTime property: A required field, indicating the end time of data for detection. Should be date-time." - returns: - description: "the endTime value." - type: "OffsetDateTime" -- uid: "com.azure.ai.anomalydetector.models.DetectionRequest.getSource()" - fullName: "com.azure.ai.anomalydetector.models.DetectionRequest.getSource()" - name: "getSource()" - nameWithType: "DetectionRequest.getSource()" - summary: "Get the source property: Source link to the input variables." - syntax: "public String getSource()" - desc: "Get the source property: Source link to the input variables. Each variable should be a csv with two columns, \\`timestamp\\` and \\`value\\`. The file name of the variable will be used as its name. The variables used in detection should be exactly the same with those used in the training phase." - returns: - description: "the source value." - type: "String" -- uid: "com.azure.ai.anomalydetector.models.DetectionRequest.getStartTime()" - fullName: "com.azure.ai.anomalydetector.models.DetectionRequest.getStartTime()" - name: "getStartTime()" - nameWithType: "DetectionRequest.getStartTime()" - summary: "Get the startTime property: A required field, indicating the start time of data for detection." - syntax: "public OffsetDateTime getStartTime()" - desc: "Get the startTime property: A required field, indicating the start time of data for detection. Should be date-time." - returns: - description: "the startTime value." - type: "OffsetDateTime" -- uid: "com.azure.ai.anomalydetector.models.DetectionRequest.setEndTime(java.time.OffsetDateTime)" - fullName: "com.azure.ai.anomalydetector.models.DetectionRequest.setEndTime(OffsetDateTime endTime)" - name: "setEndTime(OffsetDateTime endTime)" - nameWithType: "DetectionRequest.setEndTime(OffsetDateTime endTime)" - summary: "Set the endTime property: A required field, indicating the end time of data for detection." - parameters: - - description: "the endTime value to set." - name: "endTime" - type: "OffsetDateTime" - syntax: "public DetectionRequest setEndTime(OffsetDateTime endTime)" - desc: "Set the endTime property: A required field, indicating the end time of data for detection. Should be date-time." - returns: - description: "the DetectionRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionRequest.setSource(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.DetectionRequest.setSource(String source)" - name: "setSource(String source)" - nameWithType: "DetectionRequest.setSource(String source)" - summary: "Set the source property: Source link to the input variables." - parameters: - - description: "the source value to set." - name: "source" - type: "String" - syntax: "public DetectionRequest setSource(String source)" - desc: "Set the source property: Source link to the input variables. Each variable should be a csv with two columns, \\`timestamp\\` and \\`value\\`. The file name of the variable will be used as its name. The variables used in detection should be exactly the same with those used in the training phase." - returns: - description: "the DetectionRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionRequest.setStartTime(java.time.OffsetDateTime)" - fullName: "com.azure.ai.anomalydetector.models.DetectionRequest.setStartTime(OffsetDateTime startTime)" - name: "setStartTime(OffsetDateTime startTime)" - nameWithType: "DetectionRequest.setStartTime(OffsetDateTime startTime)" - summary: "Set the startTime property: A required field, indicating the start time of data for detection." - parameters: - - description: "the startTime value to set." - name: "startTime" - type: "OffsetDateTime" - syntax: "public DetectionRequest setStartTime(OffsetDateTime startTime)" - desc: "Set the startTime property: A required field, indicating the start time of data for detection. Should be date-time." - returns: - description: "the DetectionRequest object itself." - type: "" -type: "class" -desc: "Detection request." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionResult.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionResult.yml deleted file mode 100644 index 2a1f35df49d0..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionResult.yml +++ /dev/null @@ -1,107 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.DetectionResult" -fullName: "com.azure.ai.anomalydetector.models.DetectionResult" -name: "DetectionResult" -nameWithType: "DetectionResult" -summary: "Response of the given resultId." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **DetectionResult**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.DetectionResult.DetectionResult()" - fullName: "com.azure.ai.anomalydetector.models.DetectionResult.DetectionResult()" - name: "DetectionResult()" - nameWithType: "DetectionResult.DetectionResult()" - syntax: "public DetectionResult()" -methods: -- uid: "com.azure.ai.anomalydetector.models.DetectionResult.getResultId()" - fullName: "com.azure.ai.anomalydetector.models.DetectionResult.getResultId()" - name: "getResultId()" - nameWithType: "DetectionResult.getResultId()" - summary: "Get the resultId property: The resultId property." - syntax: "public UUID getResultId()" - desc: "Get the resultId property: The resultId property." - returns: - description: "the resultId value." - type: "UUID" -- uid: "com.azure.ai.anomalydetector.models.DetectionResult.getResults()" - fullName: "com.azure.ai.anomalydetector.models.DetectionResult.getResults()" - name: "getResults()" - nameWithType: "DetectionResult.getResults()" - summary: "Get the results property: Detection result for each timestamp." - syntax: "public List getResults()" - desc: "Get the results property: Detection result for each timestamp." - returns: - description: "the results value." - type: "List<>" -- uid: "com.azure.ai.anomalydetector.models.DetectionResult.getSummary()" - fullName: "com.azure.ai.anomalydetector.models.DetectionResult.getSummary()" - name: "getSummary()" - nameWithType: "DetectionResult.getSummary()" - summary: "Get the summary property: The summary property." - syntax: "public DetectionResultSummary getSummary()" - desc: "Get the summary property: The summary property." - returns: - description: "the summary value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionResult.setResultId(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.models.DetectionResult.setResultId(UUID resultId)" - name: "setResultId(UUID resultId)" - nameWithType: "DetectionResult.setResultId(UUID resultId)" - summary: "Set the resultId property: The resultId property." - parameters: - - description: "the resultId value to set." - name: "resultId" - type: "UUID" - syntax: "public DetectionResult setResultId(UUID resultId)" - desc: "Set the resultId property: The resultId property." - returns: - description: "the DetectionResult object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionResult.setResults(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.DetectionResult.setResults(List results)" - name: "setResults(List results)" - nameWithType: "DetectionResult.setResults(List results)" - summary: "Set the results property: Detection result for each timestamp." - parameters: - - description: "the results value to set." - name: "results" - type: "List<>" - syntax: "public DetectionResult setResults(List results)" - desc: "Set the results property: Detection result for each timestamp." - returns: - description: "the DetectionResult object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionResult.setSummary(com.azure.ai.anomalydetector.models.DetectionResultSummary)" - fullName: "com.azure.ai.anomalydetector.models.DetectionResult.setSummary(DetectionResultSummary summary)" - name: "setSummary(DetectionResultSummary summary)" - nameWithType: "DetectionResult.setSummary(DetectionResultSummary summary)" - summary: "Set the summary property: The summary property." - parameters: - - description: "the summary value to set." - name: "summary" - type: "" - syntax: "public DetectionResult setSummary(DetectionResultSummary summary)" - desc: "Set the summary property: The summary property." - returns: - description: "the DetectionResult object itself." - type: "" -type: "class" -desc: "Response of the given resultId." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionResultSummary.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionResultSummary.yml deleted file mode 100644 index 9dbd9d9cba74..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionResultSummary.yml +++ /dev/null @@ -1,131 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.DetectionResultSummary" -fullName: "com.azure.ai.anomalydetector.models.DetectionResultSummary" -name: "DetectionResultSummary" -nameWithType: "DetectionResultSummary" -summary: "The DetectionResultSummary model." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **DetectionResultSummary**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.DetectionResultSummary.DetectionResultSummary()" - fullName: "com.azure.ai.anomalydetector.models.DetectionResultSummary.DetectionResultSummary()" - name: "DetectionResultSummary()" - nameWithType: "DetectionResultSummary.DetectionResultSummary()" - syntax: "public DetectionResultSummary()" -methods: -- uid: "com.azure.ai.anomalydetector.models.DetectionResultSummary.getErrors()" - fullName: "com.azure.ai.anomalydetector.models.DetectionResultSummary.getErrors()" - name: "getErrors()" - nameWithType: "DetectionResultSummary.getErrors()" - summary: "Get the errors property: Error message when detection is failed." - syntax: "public List getErrors()" - desc: "Get the errors property: Error message when detection is failed." - returns: - description: "the errors value." - type: "List<>" -- uid: "com.azure.ai.anomalydetector.models.DetectionResultSummary.getSetupInfo()" - fullName: "com.azure.ai.anomalydetector.models.DetectionResultSummary.getSetupInfo()" - name: "getSetupInfo()" - nameWithType: "DetectionResultSummary.getSetupInfo()" - summary: "Get the setupInfo property: Detection request." - syntax: "public DetectionRequest getSetupInfo()" - desc: "Get the setupInfo property: Detection request." - returns: - description: "the setupInfo value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionResultSummary.getStatus()" - fullName: "com.azure.ai.anomalydetector.models.DetectionResultSummary.getStatus()" - name: "getStatus()" - nameWithType: "DetectionResultSummary.getStatus()" - summary: "Get the status property: Status of detection results." - syntax: "public DetectionStatus getStatus()" - desc: "Get the status property: Status of detection results. One of CREATED, RUNNING, READY, and FAILED." - returns: - description: "the status value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionResultSummary.getVariableStates()" - fullName: "com.azure.ai.anomalydetector.models.DetectionResultSummary.getVariableStates()" - name: "getVariableStates()" - nameWithType: "DetectionResultSummary.getVariableStates()" - summary: "Get the variableStates property: The variableStates property." - syntax: "public List getVariableStates()" - desc: "Get the variableStates property: The variableStates property." - returns: - description: "the variableStates value." - type: "List<>" -- uid: "com.azure.ai.anomalydetector.models.DetectionResultSummary.setErrors(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.DetectionResultSummary.setErrors(List errors)" - name: "setErrors(List errors)" - nameWithType: "DetectionResultSummary.setErrors(List errors)" - summary: "Set the errors property: Error message when detection is failed." - parameters: - - description: "the errors value to set." - name: "errors" - type: "List<>" - syntax: "public DetectionResultSummary setErrors(List errors)" - desc: "Set the errors property: Error message when detection is failed." - returns: - description: "the DetectionResultSummary object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionResultSummary.setSetupInfo(com.azure.ai.anomalydetector.models.DetectionRequest)" - fullName: "com.azure.ai.anomalydetector.models.DetectionResultSummary.setSetupInfo(DetectionRequest setupInfo)" - name: "setSetupInfo(DetectionRequest setupInfo)" - nameWithType: "DetectionResultSummary.setSetupInfo(DetectionRequest setupInfo)" - summary: "Set the setupInfo property: Detection request." - parameters: - - description: "the setupInfo value to set." - name: "setupInfo" - type: "" - syntax: "public DetectionResultSummary setSetupInfo(DetectionRequest setupInfo)" - desc: "Set the setupInfo property: Detection request." - returns: - description: "the DetectionResultSummary object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionResultSummary.setStatus(com.azure.ai.anomalydetector.models.DetectionStatus)" - fullName: "com.azure.ai.anomalydetector.models.DetectionResultSummary.setStatus(DetectionStatus status)" - name: "setStatus(DetectionStatus status)" - nameWithType: "DetectionResultSummary.setStatus(DetectionStatus status)" - summary: "Set the status property: Status of detection results." - parameters: - - description: "the status value to set." - name: "status" - type: "" - syntax: "public DetectionResultSummary setStatus(DetectionStatus status)" - desc: "Set the status property: Status of detection results. One of CREATED, RUNNING, READY, and FAILED." - returns: - description: "the DetectionResultSummary object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionResultSummary.setVariableStates(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.DetectionResultSummary.setVariableStates(List variableStates)" - name: "setVariableStates(List variableStates)" - nameWithType: "DetectionResultSummary.setVariableStates(List variableStates)" - summary: "Set the variableStates property: The variableStates property." - parameters: - - description: "the variableStates value to set." - name: "variableStates" - type: "List<>" - syntax: "public DetectionResultSummary setVariableStates(List variableStates)" - desc: "Set the variableStates property: The variableStates property." - returns: - description: "the DetectionResultSummary object itself." - type: "" -type: "class" -desc: "The DetectionResultSummary model." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionStatus.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionStatus.yml deleted file mode 100644 index 004ed2fbf145..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectionStatus.yml +++ /dev/null @@ -1,106 +0,0 @@ -### YamlMime:JavaEnum -uid: "com.azure.ai.anomalydetector.models.DetectionStatus" -fullName: "com.azure.ai.anomalydetector.models.DetectionStatus" -name: "DetectionStatus" -nameWithType: "DetectionStatus" -summary: "Defines values for DetectionStatus." -inheritances: -- "" -- "" -inheritedClassMethods: -- classRef: "java.lang.Enum" - methodsRef: - - "valueOf-java.lang.Class-java.lang.String-\">valueOf" - - "clone" - - "compareTo" - - "equals" - - "finalize" - - "getDeclaringClass" - - "hashCode" - - "name" - - "ordinal" - - "toString" -- classRef: "java.lang.Object" - methodsRef: - - "getClass" - - "notify" - - "notifyAll" - - "wait" - - "wait" - - "wait" -syntax: "public enum **DetectionStatus**
extends Enum<>" -fields: -- uid: "com.azure.ai.anomalydetector.models.DetectionStatus.CREATED" - fullName: "com.azure.ai.anomalydetector.models.DetectionStatus.CREATED" - name: "CREATED" - nameWithType: "DetectionStatus.CREATED" - summary: "Enum value CREATED." - desc: "Enum value CREATED." -- uid: "com.azure.ai.anomalydetector.models.DetectionStatus.FAILED" - fullName: "com.azure.ai.anomalydetector.models.DetectionStatus.FAILED" - name: "FAILED" - nameWithType: "DetectionStatus.FAILED" - summary: "Enum value FAILED." - desc: "Enum value FAILED." -- uid: "com.azure.ai.anomalydetector.models.DetectionStatus.READY" - fullName: "com.azure.ai.anomalydetector.models.DetectionStatus.READY" - name: "READY" - nameWithType: "DetectionStatus.READY" - summary: "Enum value READY." - desc: "Enum value READY." -- uid: "com.azure.ai.anomalydetector.models.DetectionStatus.RUNNING" - fullName: "com.azure.ai.anomalydetector.models.DetectionStatus.RUNNING" - name: "RUNNING" - nameWithType: "DetectionStatus.RUNNING" - summary: "Enum value RUNNING." - desc: "Enum value RUNNING." -methods: -- uid: "com.azure.ai.anomalydetector.models.DetectionStatus.fromString(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.DetectionStatus.fromString(String value)" - name: "fromString(String value)" - nameWithType: "DetectionStatus.fromString(String value)" - summary: "Parses a serialized value to a DetectionStatus instance." - modifiers: - - "static" - parameters: - - description: "the serialized value to parse." - name: "value" - type: "String" - syntax: "public static DetectionStatus fromString(String value)" - desc: "Parses a serialized value to a DetectionStatus instance." - returns: - description: "the parsed DetectionStatus object, or null if unable to parse." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionStatus.toString()" - fullName: "com.azure.ai.anomalydetector.models.DetectionStatus.toString()" - name: "toString()" - nameWithType: "DetectionStatus.toString()" - overridden: "java.lang.Enum.toString()" - syntax: "public String toString()" - returns: - type: "String" -- uid: "com.azure.ai.anomalydetector.models.DetectionStatus.valueOf(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.DetectionStatus.valueOf(String name)" - name: "valueOf(String name)" - nameWithType: "DetectionStatus.valueOf(String name)" - modifiers: - - "static" - parameters: - - name: "name" - type: "String" - syntax: "public static DetectionStatus valueOf(String name)" - returns: - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectionStatus.values()" - fullName: "com.azure.ai.anomalydetector.models.DetectionStatus.values()" - name: "values()" - nameWithType: "DetectionStatus.values()" - modifiers: - - "static" - syntax: "public static DetectionStatus[] values()" - returns: - type: "[]" -desc: "Defines values for DetectionStatus." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DiagnosticsInfo.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DiagnosticsInfo.yml index 83930aa8795e..57f3a09bec17 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DiagnosticsInfo.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DiagnosticsInfo.yml @@ -3,7 +3,7 @@ uid: "com.azure.ai.anomalydetector.models.DiagnosticsInfo" fullName: "com.azure.ai.anomalydetector.models.DiagnosticsInfo" name: "DiagnosticsInfo" nameWithType: "DiagnosticsInfo" -summary: "The DiagnosticsInfo model." +summary: "Diagnostics information to help inspect the states of model or variable." inheritances: - "" inheritedClassMethods: @@ -26,15 +26,17 @@ constructors: fullName: "com.azure.ai.anomalydetector.models.DiagnosticsInfo.DiagnosticsInfo()" name: "DiagnosticsInfo()" nameWithType: "DiagnosticsInfo.DiagnosticsInfo()" + summary: "Creates an instance of DiagnosticsInfo class." syntax: "public DiagnosticsInfo()" + desc: "Creates an instance of DiagnosticsInfo class." methods: - uid: "com.azure.ai.anomalydetector.models.DiagnosticsInfo.getModelState()" fullName: "com.azure.ai.anomalydetector.models.DiagnosticsInfo.getModelState()" name: "getModelState()" nameWithType: "DiagnosticsInfo.getModelState()" - summary: "Get the modelState property: The modelState property." + summary: "Get the modelState property: Model status." syntax: "public ModelState getModelState()" - desc: "Get the modelState property: The modelState property." + desc: "Get the modelState property: Model status." returns: description: "the modelState value." type: "" @@ -42,9 +44,9 @@ methods: fullName: "com.azure.ai.anomalydetector.models.DiagnosticsInfo.getVariableStates()" name: "getVariableStates()" nameWithType: "DiagnosticsInfo.getVariableStates()" - summary: "Get the variableStates property: The variableStates property." + summary: "Get the variableStates property: Variable Status." syntax: "public List getVariableStates()" - desc: "Get the variableStates property: The variableStates property." + desc: "Get the variableStates property: Variable Status." returns: description: "the variableStates value." type: "List<>" @@ -52,13 +54,13 @@ methods: fullName: "com.azure.ai.anomalydetector.models.DiagnosticsInfo.setModelState(ModelState modelState)" name: "setModelState(ModelState modelState)" nameWithType: "DiagnosticsInfo.setModelState(ModelState modelState)" - summary: "Set the modelState property: The modelState property." + summary: "Set the modelState property: Model status." parameters: - description: "the modelState value to set." name: "modelState" type: "" syntax: "public DiagnosticsInfo setModelState(ModelState modelState)" - desc: "Set the modelState property: The modelState property." + desc: "Set the modelState property: Model status." returns: description: "the DiagnosticsInfo object itself." type: "" @@ -66,18 +68,18 @@ methods: fullName: "com.azure.ai.anomalydetector.models.DiagnosticsInfo.setVariableStates(List variableStates)" name: "setVariableStates(List variableStates)" nameWithType: "DiagnosticsInfo.setVariableStates(List variableStates)" - summary: "Set the variableStates property: The variableStates property." + summary: "Set the variableStates property: Variable Status." parameters: - description: "the variableStates value to set." name: "variableStates" type: "List<>" syntax: "public DiagnosticsInfo setVariableStates(List variableStates)" - desc: "Set the variableStates property: The variableStates property." + desc: "Set the variableStates property: Variable Status." returns: description: "the DiagnosticsInfo object itself." type: "" type: "class" -desc: "The DiagnosticsInfo model." +desc: "Diagnostics information to help inspect the states of model or variable." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.EntireDetectResponse.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.EntireDetectResponse.yml deleted file mode 100644 index 364642af1c4e..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.EntireDetectResponse.yml +++ /dev/null @@ -1,227 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse" -fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse" -name: "EntireDetectResponse" -nameWithType: "EntireDetectResponse" -summary: "The response of entire anomaly detection." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **EntireDetectResponse**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.EntireDetectResponse()" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.EntireDetectResponse()" - name: "EntireDetectResponse()" - nameWithType: "EntireDetectResponse.EntireDetectResponse()" - syntax: "public EntireDetectResponse()" -methods: -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getExpectedValues()" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getExpectedValues()" - name: "getExpectedValues()" - nameWithType: "EntireDetectResponse.getExpectedValues()" - summary: "Get the expectedValues property: ExpectedValues contain expected value for each input point." - syntax: "public List getExpectedValues()" - desc: "Get the expectedValues property: ExpectedValues contain expected value for each input point. The index of the array is consistent with the input series." - returns: - description: "the expectedValues value." - type: "List<Float>" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getIsAnomaly()" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getIsAnomaly()" - name: "getIsAnomaly()" - nameWithType: "EntireDetectResponse.getIsAnomaly()" - summary: "Get the isAnomaly property: IsAnomaly contains anomaly properties for each input point." - syntax: "public List getIsAnomaly()" - desc: "Get the isAnomaly property: IsAnomaly contains anomaly properties for each input point. True means an anomaly either negative or positive has been detected. The index of the array is consistent with the input series." - returns: - description: "the isAnomaly value." - type: "List<Boolean>" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getIsNegativeAnomaly()" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getIsNegativeAnomaly()" - name: "getIsNegativeAnomaly()" - nameWithType: "EntireDetectResponse.getIsNegativeAnomaly()" - summary: "Get the isNegativeAnomaly property: IsNegativeAnomaly contains anomaly status in negative direction for each input point." - syntax: "public List getIsNegativeAnomaly()" - desc: "Get the isNegativeAnomaly property: IsNegativeAnomaly contains anomaly status in negative direction for each input point. True means a negative anomaly has been detected. A negative anomaly means the point is detected as an anomaly and its real value is smaller than the expected one. The index of the array is consistent with the input series." - returns: - description: "the isNegativeAnomaly value." - type: "List<Boolean>" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getIsPositiveAnomaly()" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getIsPositiveAnomaly()" - name: "getIsPositiveAnomaly()" - nameWithType: "EntireDetectResponse.getIsPositiveAnomaly()" - summary: "Get the isPositiveAnomaly property: IsPositiveAnomaly contain anomaly status in positive direction for each input point." - syntax: "public List getIsPositiveAnomaly()" - desc: "Get the isPositiveAnomaly property: IsPositiveAnomaly contain anomaly status in positive direction for each input point. True means a positive anomaly has been detected. A positive anomaly means the point is detected as an anomaly and its real value is larger than the expected one. The index of the array is consistent with the input series." - returns: - description: "the isPositiveAnomaly value." - type: "List<Boolean>" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getLowerMargins()" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getLowerMargins()" - name: "getLowerMargins()" - nameWithType: "EntireDetectResponse.getLowerMargins()" - summary: "Get the lowerMargins property: LowerMargins contain lower margin of each input point." - syntax: "public List getLowerMargins()" - desc: "Get the lowerMargins property: LowerMargins contain lower margin of each input point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)\\*lowerMargin. Points between the boundary can be marked as normal ones in client side. The index of the array is consistent with the input series." - returns: - description: "the lowerMargins value." - type: "List<Float>" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getPeriod()" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getPeriod()" - name: "getPeriod()" - nameWithType: "EntireDetectResponse.getPeriod()" - summary: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." - syntax: "public int getPeriod()" - desc: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." - returns: - description: "the period value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getSeverity()" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getSeverity()" - name: "getSeverity()" - nameWithType: "EntireDetectResponse.getSeverity()" - summary: "Get the severity property: The severity score for each input point." - syntax: "public List getSeverity()" - desc: "Get the severity property: The severity score for each input point. The larger the value is, the more sever the anomaly is. For normal points, the \"severity\" is always 0." - returns: - description: "the severity value." - type: "List<Float>" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getUpperMargins()" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.getUpperMargins()" - name: "getUpperMargins()" - nameWithType: "EntireDetectResponse.getUpperMargins()" - summary: "Get the upperMargins property: UpperMargins contain upper margin of each input point." - syntax: "public List getUpperMargins()" - desc: "Get the upperMargins property: UpperMargins contain upper margin of each input point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)\\*upperMargin. Anomalies in response can be filtered by upperBoundary and lowerBoundary. By adjusting marginScale value, less significant anomalies can be filtered in client side. The index of the array is consistent with the input series." - returns: - description: "the upperMargins value." - type: "List<Float>" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setExpectedValues(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setExpectedValues(List expectedValues)" - name: "setExpectedValues(List expectedValues)" - nameWithType: "EntireDetectResponse.setExpectedValues(List expectedValues)" - summary: "Set the expectedValues property: ExpectedValues contain expected value for each input point." - parameters: - - description: "the expectedValues value to set." - name: "expectedValues" - type: "List<Float>" - syntax: "public EntireDetectResponse setExpectedValues(List expectedValues)" - desc: "Set the expectedValues property: ExpectedValues contain expected value for each input point. The index of the array is consistent with the input series." - returns: - description: "the EntireDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setIsAnomaly(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setIsAnomaly(List isAnomaly)" - name: "setIsAnomaly(List isAnomaly)" - nameWithType: "EntireDetectResponse.setIsAnomaly(List isAnomaly)" - summary: "Set the isAnomaly property: IsAnomaly contains anomaly properties for each input point." - parameters: - - description: "the isAnomaly value to set." - name: "isAnomaly" - type: "List<Boolean>" - syntax: "public EntireDetectResponse setIsAnomaly(List isAnomaly)" - desc: "Set the isAnomaly property: IsAnomaly contains anomaly properties for each input point. True means an anomaly either negative or positive has been detected. The index of the array is consistent with the input series." - returns: - description: "the EntireDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setIsNegativeAnomaly(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setIsNegativeAnomaly(List isNegativeAnomaly)" - name: "setIsNegativeAnomaly(List isNegativeAnomaly)" - nameWithType: "EntireDetectResponse.setIsNegativeAnomaly(List isNegativeAnomaly)" - summary: "Set the isNegativeAnomaly property: IsNegativeAnomaly contains anomaly status in negative direction for each input point." - parameters: - - description: "the isNegativeAnomaly value to set." - name: "isNegativeAnomaly" - type: "List<Boolean>" - syntax: "public EntireDetectResponse setIsNegativeAnomaly(List isNegativeAnomaly)" - desc: "Set the isNegativeAnomaly property: IsNegativeAnomaly contains anomaly status in negative direction for each input point. True means a negative anomaly has been detected. A negative anomaly means the point is detected as an anomaly and its real value is smaller than the expected one. The index of the array is consistent with the input series." - returns: - description: "the EntireDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setIsPositiveAnomaly(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setIsPositiveAnomaly(List isPositiveAnomaly)" - name: "setIsPositiveAnomaly(List isPositiveAnomaly)" - nameWithType: "EntireDetectResponse.setIsPositiveAnomaly(List isPositiveAnomaly)" - summary: "Set the isPositiveAnomaly property: IsPositiveAnomaly contain anomaly status in positive direction for each input point." - parameters: - - description: "the isPositiveAnomaly value to set." - name: "isPositiveAnomaly" - type: "List<Boolean>" - syntax: "public EntireDetectResponse setIsPositiveAnomaly(List isPositiveAnomaly)" - desc: "Set the isPositiveAnomaly property: IsPositiveAnomaly contain anomaly status in positive direction for each input point. True means a positive anomaly has been detected. A positive anomaly means the point is detected as an anomaly and its real value is larger than the expected one. The index of the array is consistent with the input series." - returns: - description: "the EntireDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setLowerMargins(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setLowerMargins(List lowerMargins)" - name: "setLowerMargins(List lowerMargins)" - nameWithType: "EntireDetectResponse.setLowerMargins(List lowerMargins)" - summary: "Set the lowerMargins property: LowerMargins contain lower margin of each input point." - parameters: - - description: "the lowerMargins value to set." - name: "lowerMargins" - type: "List<Float>" - syntax: "public EntireDetectResponse setLowerMargins(List lowerMargins)" - desc: "Set the lowerMargins property: LowerMargins contain lower margin of each input point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)\\*lowerMargin. Points between the boundary can be marked as normal ones in client side. The index of the array is consistent with the input series." - returns: - description: "the EntireDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setPeriod(int)" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setPeriod(int period)" - name: "setPeriod(int period)" - nameWithType: "EntireDetectResponse.setPeriod(int period)" - summary: "Set the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." - parameters: - - description: "the period value to set." - name: "period" - type: "" - syntax: "public EntireDetectResponse setPeriod(int period)" - desc: "Set the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." - returns: - description: "the EntireDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setSeverity(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setSeverity(List severity)" - name: "setSeverity(List severity)" - nameWithType: "EntireDetectResponse.setSeverity(List severity)" - summary: "Set the severity property: The severity score for each input point." - parameters: - - description: "the severity value to set." - name: "severity" - type: "List<Float>" - syntax: "public EntireDetectResponse setSeverity(List severity)" - desc: "Set the severity property: The severity score for each input point. The larger the value is, the more sever the anomaly is. For normal points, the \"severity\" is always 0." - returns: - description: "the EntireDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setUpperMargins(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.EntireDetectResponse.setUpperMargins(List upperMargins)" - name: "setUpperMargins(List upperMargins)" - nameWithType: "EntireDetectResponse.setUpperMargins(List upperMargins)" - summary: "Set the upperMargins property: UpperMargins contain upper margin of each input point." - parameters: - - description: "the upperMargins value to set." - name: "upperMargins" - type: "List<Float>" - syntax: "public EntireDetectResponse setUpperMargins(List upperMargins)" - desc: "Set the upperMargins property: UpperMargins contain upper margin of each input point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)\\*upperMargin. Anomalies in response can be filtered by upperBoundary and lowerBoundary. By adjusting marginScale value, less significant anomalies can be filtered in client side. The index of the array is consistent with the input series." - returns: - description: "the EntireDetectResponse object itself." - type: "" -type: "class" -desc: "The response of entire anomaly detection." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ErrorResponse.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ErrorResponse.yml index b6de44c4cee4..19f5f89a8147 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ErrorResponse.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ErrorResponse.yml @@ -3,7 +3,7 @@ uid: "com.azure.ai.anomalydetector.models.ErrorResponse" fullName: "com.azure.ai.anomalydetector.models.ErrorResponse" name: "ErrorResponse" nameWithType: "ErrorResponse" -summary: "The ErrorResponse model." +summary: "ErrorResponse contains code and message that shows the error information." inheritances: - "" inheritedClassMethods: @@ -22,11 +22,20 @@ inheritedClassMethods: - "wait" syntax: "public final class **ErrorResponse**" constructors: -- uid: "com.azure.ai.anomalydetector.models.ErrorResponse.ErrorResponse()" - fullName: "com.azure.ai.anomalydetector.models.ErrorResponse.ErrorResponse()" - name: "ErrorResponse()" - nameWithType: "ErrorResponse.ErrorResponse()" - syntax: "public ErrorResponse()" +- uid: "com.azure.ai.anomalydetector.models.ErrorResponse.ErrorResponse(java.lang.String,java.lang.String)" + fullName: "com.azure.ai.anomalydetector.models.ErrorResponse.ErrorResponse(String code, String message)" + name: "ErrorResponse(String code, String message)" + nameWithType: "ErrorResponse.ErrorResponse(String code, String message)" + summary: "Creates an instance of ErrorResponse class." + parameters: + - description: "the code value to set." + name: "code" + type: "String" + - description: "the message value to set." + name: "message" + type: "String" + syntax: "public ErrorResponse(String code, String message)" + desc: "Creates an instance of ErrorResponse class." methods: - uid: "com.azure.ai.anomalydetector.models.ErrorResponse.getCode()" fullName: "com.azure.ai.anomalydetector.models.ErrorResponse.getCode()" @@ -48,36 +57,8 @@ methods: returns: description: "the message value." type: "String" -- uid: "com.azure.ai.anomalydetector.models.ErrorResponse.setCode(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.ErrorResponse.setCode(String code)" - name: "setCode(String code)" - nameWithType: "ErrorResponse.setCode(String code)" - summary: "Set the code property: The error code." - parameters: - - description: "the code value to set." - name: "code" - type: "String" - syntax: "public ErrorResponse setCode(String code)" - desc: "Set the code property: The error code." - returns: - description: "the ErrorResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ErrorResponse.setMessage(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.ErrorResponse.setMessage(String message)" - name: "setMessage(String message)" - nameWithType: "ErrorResponse.setMessage(String message)" - summary: "Set the message property: The message explaining the error reported by the service." - parameters: - - description: "the message value to set." - name: "message" - type: "String" - syntax: "public ErrorResponse setMessage(String message)" - desc: "Set the message property: The message explaining the error reported by the service." - returns: - description: "the ErrorResponse object itself." - type: "" type: "class" -desc: "The ErrorResponse model." +desc: "ErrorResponse contains code and message that shows the error information." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ErrorResponseException.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ErrorResponseException.yml deleted file mode 100644 index d3495d51c4ff..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ErrorResponseException.yml +++ /dev/null @@ -1,92 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.ErrorResponseException" -fullName: "com.azure.ai.anomalydetector.models.ErrorResponseException" -name: "ErrorResponseException" -nameWithType: "ErrorResponseException" -summary: "Exception thrown for an invalid response with ErrorResponse information." -inheritances: -- "" -- "" -- "" -- "" -- "" -- "" -inheritedClassMethods: -- classRef: "" - methodsRef: - - "" - - "" -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "wait" - - "wait" - - "wait" -- classRef: "java.lang.Throwable" - methodsRef: - - "addSuppressed" - - "fillInStackTrace" - - "getCause" - - "getLocalizedMessage" - - "getMessage" - - "getStackTrace" - - "getSuppressed" - - "initCause" - - "printStackTrace" - - "printStackTrace" - - "printStackTrace" - - "setStackTrace" - - "toString" -syntax: "public final class **ErrorResponseException**
extends " -constructors: -- uid: "com.azure.ai.anomalydetector.models.ErrorResponseException.ErrorResponseException(java.lang.String,com.azure.core.http.HttpResponse)" - fullName: "com.azure.ai.anomalydetector.models.ErrorResponseException.ErrorResponseException(String message, HttpResponse response)" - name: "ErrorResponseException(String message, HttpResponse response)" - nameWithType: "ErrorResponseException.ErrorResponseException(String message, HttpResponse response)" - summary: "Initializes a new instance of the ErrorResponseException class." - parameters: - - description: "the exception message or the response content if a message is not available." - name: "message" - type: "String" - - description: "the HTTP response." - name: "response" - type: "" - syntax: "public ErrorResponseException(String message, HttpResponse response)" - desc: "Initializes a new instance of the ErrorResponseException class." -- uid: "com.azure.ai.anomalydetector.models.ErrorResponseException.ErrorResponseException(java.lang.String,com.azure.core.http.HttpResponse,com.azure.ai.anomalydetector.models.ErrorResponse)" - fullName: "com.azure.ai.anomalydetector.models.ErrorResponseException.ErrorResponseException(String message, HttpResponse response, ErrorResponse value)" - name: "ErrorResponseException(String message, HttpResponse response, ErrorResponse value)" - nameWithType: "ErrorResponseException.ErrorResponseException(String message, HttpResponse response, ErrorResponse value)" - summary: "Initializes a new instance of the ErrorResponseException class." - parameters: - - description: "the exception message or the response content if a message is not available." - name: "message" - type: "String" - - description: "the HTTP response." - name: "response" - type: "" - - description: "the deserialized response value." - name: "value" - type: "" - syntax: "public ErrorResponseException(String message, HttpResponse response, ErrorResponse value)" - desc: "Initializes a new instance of the ErrorResponseException class." -methods: -- uid: "com.azure.ai.anomalydetector.models.ErrorResponseException.getValue()" - fullName: "com.azure.ai.anomalydetector.models.ErrorResponseException.getValue()" - name: "getValue()" - nameWithType: "ErrorResponseException.getValue()" - overridden: "com.azure.core.exception.HttpResponseException.getValue()" - syntax: "public ErrorResponse getValue()" - returns: - type: "" -type: "class" -desc: "Exception thrown for an invalid response with ErrorResponse information." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.FillNAMethod.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.FillNAMethod.yml index 7151c020bec2..905de5ef0553 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.FillNAMethod.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.FillNAMethod.yml @@ -1,9 +1,9 @@ ### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.FillNaMethod" -fullName: "com.azure.ai.anomalydetector.models.FillNaMethod" -name: "FillNaMethod" -nameWithType: "FillNaMethod" -summary: "Defines values for FillNaMethod." +uid: "com.azure.ai.anomalydetector.models.FillNAMethod" +fullName: "com.azure.ai.anomalydetector.models.FillNAMethod" +name: "FillNAMethod" +nameWithType: "FillNAMethod" +summary: "Defines values for FillNAMethod." inheritances: - "" - "" @@ -25,115 +25,105 @@ inheritedClassMethods: - "wait" - "wait" - "wait" -syntax: "public final class **FillNaMethod**
extends <>" +syntax: "public final class **FillNAMethod**
extends <>" constructors: -- uid: "com.azure.ai.anomalydetector.models.FillNaMethod.FillNaMethod()" - fullName: "com.azure.ai.anomalydetector.models.FillNaMethod.FillNaMethod()" - name: "FillNaMethod()" - nameWithType: "FillNaMethod.FillNaMethod()" - syntax: "public FillNaMethod()" +- uid: "com.azure.ai.anomalydetector.models.FillNAMethod.FillNAMethod()" + fullName: "com.azure.ai.anomalydetector.models.FillNAMethod.FillNAMethod()" + name: "FillNAMethod()" + nameWithType: "FillNAMethod.FillNAMethod()" + syntax: "public FillNAMethod()" fields: -- uid: "com.azure.ai.anomalydetector.models.FillNaMethod.FIXED" - fullName: "com.azure.ai.anomalydetector.models.FillNaMethod.FIXED" +- uid: "com.azure.ai.anomalydetector.models.FillNAMethod.FIXED" + fullName: "com.azure.ai.anomalydetector.models.FillNAMethod.FIXED" name: "FIXED" - nameWithType: "FillNaMethod.FIXED" - summary: "Static value Fixed for FillNaMethod." + nameWithType: "FillNAMethod.FIXED" + summary: "Static value Fixed for FillNAMethod." modifiers: - "static" - "final" field: - type: "" - syntax: "public static final FillNaMethod FIXED" - desc: "Static value Fixed for FillNaMethod." -- uid: "com.azure.ai.anomalydetector.models.FillNaMethod.LINEAR" - fullName: "com.azure.ai.anomalydetector.models.FillNaMethod.LINEAR" + type: "" + syntax: "public static final FillNAMethod FIXED" + desc: "Static value Fixed for FillNAMethod." +- uid: "com.azure.ai.anomalydetector.models.FillNAMethod.LINEAR" + fullName: "com.azure.ai.anomalydetector.models.FillNAMethod.LINEAR" name: "LINEAR" - nameWithType: "FillNaMethod.LINEAR" - summary: "Static value Linear for FillNaMethod." + nameWithType: "FillNAMethod.LINEAR" + summary: "Static value Linear for FillNAMethod." modifiers: - "static" - "final" field: - type: "" - syntax: "public static final FillNaMethod LINEAR" - desc: "Static value Linear for FillNaMethod." -- uid: "com.azure.ai.anomalydetector.models.FillNaMethod.NOT_FILL" - fullName: "com.azure.ai.anomalydetector.models.FillNaMethod.NOT_FILL" - name: "NOT_FILL" - nameWithType: "FillNaMethod.NOT_FILL" - summary: "Static value NotFill for FillNaMethod." - modifiers: - - "static" - - "final" - field: - type: "" - syntax: "public static final FillNaMethod NOT_FILL" - desc: "Static value NotFill for FillNaMethod." -- uid: "com.azure.ai.anomalydetector.models.FillNaMethod.PREVIOUS" - fullName: "com.azure.ai.anomalydetector.models.FillNaMethod.PREVIOUS" + type: "" + syntax: "public static final FillNAMethod LINEAR" + desc: "Static value Linear for FillNAMethod." +- uid: "com.azure.ai.anomalydetector.models.FillNAMethod.PREVIOUS" + fullName: "com.azure.ai.anomalydetector.models.FillNAMethod.PREVIOUS" name: "PREVIOUS" - nameWithType: "FillNaMethod.PREVIOUS" - summary: "Static value Previous for FillNaMethod." + nameWithType: "FillNAMethod.PREVIOUS" + summary: "Static value Previous for FillNAMethod." modifiers: - "static" - "final" field: - type: "" - syntax: "public static final FillNaMethod PREVIOUS" - desc: "Static value Previous for FillNaMethod." -- uid: "com.azure.ai.anomalydetector.models.FillNaMethod.SUBSEQUENT" - fullName: "com.azure.ai.anomalydetector.models.FillNaMethod.SUBSEQUENT" + type: "" + syntax: "public static final FillNAMethod PREVIOUS" + desc: "Static value Previous for FillNAMethod." +- uid: "com.azure.ai.anomalydetector.models.FillNAMethod.SUBSEQUENT" + fullName: "com.azure.ai.anomalydetector.models.FillNAMethod.SUBSEQUENT" name: "SUBSEQUENT" - nameWithType: "FillNaMethod.SUBSEQUENT" - summary: "Static value Subsequent for FillNaMethod." + nameWithType: "FillNAMethod.SUBSEQUENT" + summary: "Static value Subsequent for FillNAMethod." modifiers: - "static" - "final" field: - type: "" - syntax: "public static final FillNaMethod SUBSEQUENT" - desc: "Static value Subsequent for FillNaMethod." -- uid: "com.azure.ai.anomalydetector.models.FillNaMethod.ZERO" - fullName: "com.azure.ai.anomalydetector.models.FillNaMethod.ZERO" + type: "" + syntax: "public static final FillNAMethod SUBSEQUENT" + desc: "Static value Subsequent for FillNAMethod." +- uid: "com.azure.ai.anomalydetector.models.FillNAMethod.ZERO" + fullName: "com.azure.ai.anomalydetector.models.FillNAMethod.ZERO" name: "ZERO" - nameWithType: "FillNaMethod.ZERO" - summary: "Static value Zero for FillNaMethod." + nameWithType: "FillNAMethod.ZERO" + summary: "Static value Zero for FillNAMethod." modifiers: - "static" - "final" field: - type: "" - syntax: "public static final FillNaMethod ZERO" - desc: "Static value Zero for FillNaMethod." + type: "" + syntax: "public static final FillNAMethod ZERO" + desc: "Static value Zero for FillNAMethod." methods: -- uid: "com.azure.ai.anomalydetector.models.FillNaMethod.fromString(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.FillNaMethod.fromString(String name)" +- uid: "com.azure.ai.anomalydetector.models.FillNAMethod.fromString(java.lang.String)" + fullName: "com.azure.ai.anomalydetector.models.FillNAMethod.fromString(String name)" name: "fromString(String name)" - nameWithType: "FillNaMethod.fromString(String name)" - summary: "Creates or finds a FillNaMethod from its string representation." + nameWithType: "FillNAMethod.fromString(String name)" + summary: "Creates or finds a FillNAMethod from its string representation." modifiers: - "static" parameters: - description: "a name to look for." name: "name" type: "String" - syntax: "public static FillNaMethod fromString(String name)" - desc: "Creates or finds a FillNaMethod from its string representation." + syntax: "public static FillNAMethod fromString(String name)" + desc: "Creates or finds a FillNAMethod from its string representation." returns: - description: "the corresponding FillNaMethod." - type: "" -- uid: "com.azure.ai.anomalydetector.models.FillNaMethod.values()" - fullName: "com.azure.ai.anomalydetector.models.FillNaMethod.values()" + description: "the corresponding FillNAMethod." + type: "" +- uid: "com.azure.ai.anomalydetector.models.FillNAMethod.values()" + fullName: "com.azure.ai.anomalydetector.models.FillNAMethod.values()" name: "values()" - nameWithType: "FillNaMethod.values()" + nameWithType: "FillNAMethod.values()" + summary: "Gets known FillNAMethod values." modifiers: - "static" - syntax: "public static Collection values()" + syntax: "public static Collection values()" + desc: "Gets known FillNAMethod values." returns: - description: "known FillNaMethod values." - type: "Collection<>" + description: "known FillNAMethod values." + type: "Collection<>" type: "class" -desc: "Defines values for FillNaMethod." +desc: "Defines values for FillNAMethod." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ImputeMode.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ImputeMode.yml index 19405c7d36f8..1f7b7fc519ab 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ImputeMode.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ImputeMode.yml @@ -126,9 +126,11 @@ methods: fullName: "com.azure.ai.anomalydetector.models.ImputeMode.values()" name: "values()" nameWithType: "ImputeMode.values()" + summary: "Gets known ImputeMode values." modifiers: - "static" syntax: "public static Collection values()" + desc: "Gets known ImputeMode values." returns: description: "known ImputeMode values." type: "Collection<>" @@ -136,4 +138,4 @@ type: "class" desc: "Defines values for ImputeMode." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectResponse.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectResponse.yml deleted file mode 100644 index 557ae3800067..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectResponse.yml +++ /dev/null @@ -1,251 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.LastDetectResponse" -fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse" -name: "LastDetectResponse" -nameWithType: "LastDetectResponse" -summary: "The response of last anomaly detection." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **LastDetectResponse**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.LastDetectResponse()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.LastDetectResponse()" - name: "LastDetectResponse()" - nameWithType: "LastDetectResponse.LastDetectResponse()" - syntax: "public LastDetectResponse()" -methods: -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.getExpectedValue()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.getExpectedValue()" - name: "getExpectedValue()" - nameWithType: "LastDetectResponse.getExpectedValue()" - summary: "Get the expectedValue property: Expected value of the latest point." - syntax: "public float getExpectedValue()" - desc: "Get the expectedValue property: Expected value of the latest point." - returns: - description: "the expectedValue value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.getLowerMargin()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.getLowerMargin()" - name: "getLowerMargin()" - nameWithType: "LastDetectResponse.getLowerMargin()" - summary: "Get the lowerMargin property: Lower margin of the latest point." - syntax: "public float getLowerMargin()" - desc: "Get the lowerMargin property: Lower margin of the latest point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)\\*lowerMargin." - returns: - description: "the lowerMargin value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.getPeriod()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.getPeriod()" - name: "getPeriod()" - nameWithType: "LastDetectResponse.getPeriod()" - summary: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." - syntax: "public int getPeriod()" - desc: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." - returns: - description: "the period value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.getSeverity()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.getSeverity()" - name: "getSeverity()" - nameWithType: "LastDetectResponse.getSeverity()" - summary: "Get the severity property: The severity score for the last input point." - syntax: "public Float getSeverity()" - desc: "Get the severity property: The severity score for the last input point. The larger the value is, the more sever the anomaly is. For normal points, the \"severity\" is always 0." - returns: - description: "the severity value." - type: "Float" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.getSuggestedWindow()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.getSuggestedWindow()" - name: "getSuggestedWindow()" - nameWithType: "LastDetectResponse.getSuggestedWindow()" - summary: "Get the suggestedWindow property: Suggested input series points needed for detecting the latest point." - syntax: "public int getSuggestedWindow()" - desc: "Get the suggestedWindow property: Suggested input series points needed for detecting the latest point." - returns: - description: "the suggestedWindow value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.getUpperMargin()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.getUpperMargin()" - name: "getUpperMargin()" - nameWithType: "LastDetectResponse.getUpperMargin()" - summary: "Get the upperMargin property: Upper margin of the latest point." - syntax: "public float getUpperMargin()" - desc: "Get the upperMargin property: Upper margin of the latest point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)\\*upperMargin. If the value of latest point is between upperBoundary and lowerBoundary, it should be treated as normal value. By adjusting marginScale value, anomaly status of latest point can be changed." - returns: - description: "the upperMargin value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.isAnomaly()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.isAnomaly()" - name: "isAnomaly()" - nameWithType: "LastDetectResponse.isAnomaly()" - summary: "Get the isAnomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction." - syntax: "public boolean isAnomaly()" - desc: "Get the isAnomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction." - returns: - description: "the isAnomaly value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.isNegativeAnomaly()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.isNegativeAnomaly()" - name: "isNegativeAnomaly()" - nameWithType: "LastDetectResponse.isNegativeAnomaly()" - summary: "Get the isNegativeAnomaly property: Anomaly status in negative direction of the latest point." - syntax: "public boolean isNegativeAnomaly()" - desc: "Get the isNegativeAnomaly property: Anomaly status in negative direction of the latest point. True means the latest point is an anomaly and its real value is smaller than the expected one." - returns: - description: "the isNegativeAnomaly value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.isPositiveAnomaly()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.isPositiveAnomaly()" - name: "isPositiveAnomaly()" - nameWithType: "LastDetectResponse.isPositiveAnomaly()" - summary: "Get the isPositiveAnomaly property: Anomaly status in positive direction of the latest point." - syntax: "public boolean isPositiveAnomaly()" - desc: "Get the isPositiveAnomaly property: Anomaly status in positive direction of the latest point. True means the latest point is an anomaly and its real value is larger than the expected one." - returns: - description: "the isPositiveAnomaly value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.setExpectedValue(float)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.setExpectedValue(float expectedValue)" - name: "setExpectedValue(float expectedValue)" - nameWithType: "LastDetectResponse.setExpectedValue(float expectedValue)" - summary: "Set the expectedValue property: Expected value of the latest point." - parameters: - - description: "the expectedValue value to set." - name: "expectedValue" - type: "" - syntax: "public LastDetectResponse setExpectedValue(float expectedValue)" - desc: "Set the expectedValue property: Expected value of the latest point." - returns: - description: "the LastDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.setIsAnomaly(boolean)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.setIsAnomaly(boolean isAnomaly)" - name: "setIsAnomaly(boolean isAnomaly)" - nameWithType: "LastDetectResponse.setIsAnomaly(boolean isAnomaly)" - summary: "Set the isAnomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction." - parameters: - - description: "the isAnomaly value to set." - name: "isAnomaly" - type: "" - syntax: "public LastDetectResponse setIsAnomaly(boolean isAnomaly)" - desc: "Set the isAnomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction." - returns: - description: "the LastDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.setIsNegativeAnomaly(boolean)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.setIsNegativeAnomaly(boolean isNegativeAnomaly)" - name: "setIsNegativeAnomaly(boolean isNegativeAnomaly)" - nameWithType: "LastDetectResponse.setIsNegativeAnomaly(boolean isNegativeAnomaly)" - summary: "Set the isNegativeAnomaly property: Anomaly status in negative direction of the latest point." - parameters: - - description: "the isNegativeAnomaly value to set." - name: "isNegativeAnomaly" - type: "" - syntax: "public LastDetectResponse setIsNegativeAnomaly(boolean isNegativeAnomaly)" - desc: "Set the isNegativeAnomaly property: Anomaly status in negative direction of the latest point. True means the latest point is an anomaly and its real value is smaller than the expected one." - returns: - description: "the LastDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.setIsPositiveAnomaly(boolean)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.setIsPositiveAnomaly(boolean isPositiveAnomaly)" - name: "setIsPositiveAnomaly(boolean isPositiveAnomaly)" - nameWithType: "LastDetectResponse.setIsPositiveAnomaly(boolean isPositiveAnomaly)" - summary: "Set the isPositiveAnomaly property: Anomaly status in positive direction of the latest point." - parameters: - - description: "the isPositiveAnomaly value to set." - name: "isPositiveAnomaly" - type: "" - syntax: "public LastDetectResponse setIsPositiveAnomaly(boolean isPositiveAnomaly)" - desc: "Set the isPositiveAnomaly property: Anomaly status in positive direction of the latest point. True means the latest point is an anomaly and its real value is larger than the expected one." - returns: - description: "the LastDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.setLowerMargin(float)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.setLowerMargin(float lowerMargin)" - name: "setLowerMargin(float lowerMargin)" - nameWithType: "LastDetectResponse.setLowerMargin(float lowerMargin)" - summary: "Set the lowerMargin property: Lower margin of the latest point." - parameters: - - description: "the lowerMargin value to set." - name: "lowerMargin" - type: "" - syntax: "public LastDetectResponse setLowerMargin(float lowerMargin)" - desc: "Set the lowerMargin property: Lower margin of the latest point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)\\*lowerMargin." - returns: - description: "the LastDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.setPeriod(int)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.setPeriod(int period)" - name: "setPeriod(int period)" - nameWithType: "LastDetectResponse.setPeriod(int period)" - summary: "Set the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." - parameters: - - description: "the period value to set." - name: "period" - type: "" - syntax: "public LastDetectResponse setPeriod(int period)" - desc: "Set the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." - returns: - description: "the LastDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.setSeverity(java.lang.Float)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.setSeverity(Float severity)" - name: "setSeverity(Float severity)" - nameWithType: "LastDetectResponse.setSeverity(Float severity)" - summary: "Set the severity property: The severity score for the last input point." - parameters: - - description: "the severity value to set." - name: "severity" - type: "Float" - syntax: "public LastDetectResponse setSeverity(Float severity)" - desc: "Set the severity property: The severity score for the last input point. The larger the value is, the more sever the anomaly is. For normal points, the \"severity\" is always 0." - returns: - description: "the LastDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.setSuggestedWindow(int)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.setSuggestedWindow(int suggestedWindow)" - name: "setSuggestedWindow(int suggestedWindow)" - nameWithType: "LastDetectResponse.setSuggestedWindow(int suggestedWindow)" - summary: "Set the suggestedWindow property: Suggested input series points needed for detecting the latest point." - parameters: - - description: "the suggestedWindow value to set." - name: "suggestedWindow" - type: "" - syntax: "public LastDetectResponse setSuggestedWindow(int suggestedWindow)" - desc: "Set the suggestedWindow property: Suggested input series points needed for detecting the latest point." - returns: - description: "the LastDetectResponse object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectResponse.setUpperMargin(float)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectResponse.setUpperMargin(float upperMargin)" - name: "setUpperMargin(float upperMargin)" - nameWithType: "LastDetectResponse.setUpperMargin(float upperMargin)" - summary: "Set the upperMargin property: Upper margin of the latest point." - parameters: - - description: "the upperMargin value to set." - name: "upperMargin" - type: "" - syntax: "public LastDetectResponse setUpperMargin(float upperMargin)" - desc: "Set the upperMargin property: Upper margin of the latest point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)\\*upperMargin. If the value of latest point is between upperBoundary and lowerBoundary, it should be treated as normal value. By adjusting marginScale value, anomaly status of latest point can be changed." - returns: - description: "the LastDetectResponse object itself." - type: "" -type: "class" -desc: "The response of last anomaly detection." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectionRequest.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectionRequest.yml deleted file mode 100644 index 35e9396aeceb..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectionRequest.yml +++ /dev/null @@ -1,83 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.LastDetectionRequest" -fullName: "com.azure.ai.anomalydetector.models.LastDetectionRequest" -name: "LastDetectionRequest" -nameWithType: "LastDetectionRequest" -summary: "The LastDetectionRequest model." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **LastDetectionRequest**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.LastDetectionRequest.LastDetectionRequest()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectionRequest.LastDetectionRequest()" - name: "LastDetectionRequest()" - nameWithType: "LastDetectionRequest.LastDetectionRequest()" - syntax: "public LastDetectionRequest()" -methods: -- uid: "com.azure.ai.anomalydetector.models.LastDetectionRequest.getDetectingPoints()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectionRequest.getDetectingPoints()" - name: "getDetectingPoints()" - nameWithType: "LastDetectionRequest.getDetectingPoints()" - summary: "Get the detectingPoints property: number of timestamps on which the model detects." - syntax: "public int getDetectingPoints()" - desc: "Get the detectingPoints property: number of timestamps on which the model detects." - returns: - description: "the detectingPoints value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectionRequest.getVariables()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectionRequest.getVariables()" - name: "getVariables()" - nameWithType: "LastDetectionRequest.getVariables()" - summary: "Get the variables property: variables." - syntax: "public List getVariables()" - desc: "Get the variables property: variables." - returns: - description: "the variables value." - type: "List<>" -- uid: "com.azure.ai.anomalydetector.models.LastDetectionRequest.setDetectingPoints(int)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectionRequest.setDetectingPoints(int detectingPoints)" - name: "setDetectingPoints(int detectingPoints)" - nameWithType: "LastDetectionRequest.setDetectingPoints(int detectingPoints)" - summary: "Set the detectingPoints property: number of timestamps on which the model detects." - parameters: - - description: "the detectingPoints value to set." - name: "detectingPoints" - type: "" - syntax: "public LastDetectionRequest setDetectingPoints(int detectingPoints)" - desc: "Set the detectingPoints property: number of timestamps on which the model detects." - returns: - description: "the LastDetectionRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectionRequest.setVariables(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectionRequest.setVariables(List variables)" - name: "setVariables(List variables)" - nameWithType: "LastDetectionRequest.setVariables(List variables)" - summary: "Set the variables property: variables." - parameters: - - description: "the variables value to set." - name: "variables" - type: "List<>" - syntax: "public LastDetectionRequest setVariables(List variables)" - desc: "Set the variables property: variables." - returns: - description: "the LastDetectionRequest object itself." - type: "" -type: "class" -desc: "The LastDetectionRequest model." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectionResult.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectionResult.yml deleted file mode 100644 index a69367022088..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.LastDetectionResult.yml +++ /dev/null @@ -1,83 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.LastDetectionResult" -fullName: "com.azure.ai.anomalydetector.models.LastDetectionResult" -name: "LastDetectionResult" -nameWithType: "LastDetectionResult" -summary: "The LastDetectionResult model." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **LastDetectionResult**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.LastDetectionResult.LastDetectionResult()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectionResult.LastDetectionResult()" - name: "LastDetectionResult()" - nameWithType: "LastDetectionResult.LastDetectionResult()" - syntax: "public LastDetectionResult()" -methods: -- uid: "com.azure.ai.anomalydetector.models.LastDetectionResult.getResults()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectionResult.getResults()" - name: "getResults()" - nameWithType: "LastDetectionResult.getResults()" - summary: "Get the results property: The results property." - syntax: "public List getResults()" - desc: "Get the results property: The results property." - returns: - description: "the results value." - type: "List<>" -- uid: "com.azure.ai.anomalydetector.models.LastDetectionResult.getVariableStates()" - fullName: "com.azure.ai.anomalydetector.models.LastDetectionResult.getVariableStates()" - name: "getVariableStates()" - nameWithType: "LastDetectionResult.getVariableStates()" - summary: "Get the variableStates property: The variableStates property." - syntax: "public List getVariableStates()" - desc: "Get the variableStates property: The variableStates property." - returns: - description: "the variableStates value." - type: "List<>" -- uid: "com.azure.ai.anomalydetector.models.LastDetectionResult.setResults(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectionResult.setResults(List results)" - name: "setResults(List results)" - nameWithType: "LastDetectionResult.setResults(List results)" - summary: "Set the results property: The results property." - parameters: - - description: "the results value to set." - name: "results" - type: "List<>" - syntax: "public LastDetectionResult setResults(List results)" - desc: "Set the results property: The results property." - returns: - description: "the LastDetectionResult object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.LastDetectionResult.setVariableStates(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.LastDetectionResult.setVariableStates(List variableStates)" - name: "setVariableStates(List variableStates)" - nameWithType: "LastDetectionResult.setVariableStates(List variableStates)" - summary: "Set the variableStates property: The variableStates property." - parameters: - - description: "the variableStates value to set." - name: "variableStates" - type: "List<>" - syntax: "public LastDetectionResult setVariableStates(List variableStates)" - desc: "Set the variableStates property: The variableStates property." - returns: - description: "the LastDetectionResult object itself." - type: "" -type: "class" -desc: "The LastDetectionResult model." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.Model.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.Model.yml deleted file mode 100644 index 3a982c9d1ef2..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.Model.yml +++ /dev/null @@ -1,131 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.Model" -fullName: "com.azure.ai.anomalydetector.models.Model" -name: "Model" -nameWithType: "Model" -summary: "Response of getting a model." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **Model**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.Model.Model()" - fullName: "com.azure.ai.anomalydetector.models.Model.Model()" - name: "Model()" - nameWithType: "Model.Model()" - syntax: "public Model()" -methods: -- uid: "com.azure.ai.anomalydetector.models.Model.getCreatedTime()" - fullName: "com.azure.ai.anomalydetector.models.Model.getCreatedTime()" - name: "getCreatedTime()" - nameWithType: "Model.getCreatedTime()" - summary: "Get the createdTime property: Date and time (UTC) when the model was created." - syntax: "public OffsetDateTime getCreatedTime()" - desc: "Get the createdTime property: Date and time (UTC) when the model was created." - returns: - description: "the createdTime value." - type: "OffsetDateTime" -- uid: "com.azure.ai.anomalydetector.models.Model.getLastUpdatedTime()" - fullName: "com.azure.ai.anomalydetector.models.Model.getLastUpdatedTime()" - name: "getLastUpdatedTime()" - nameWithType: "Model.getLastUpdatedTime()" - summary: "Get the lastUpdatedTime property: Date and time (UTC) when the model was last updated." - syntax: "public OffsetDateTime getLastUpdatedTime()" - desc: "Get the lastUpdatedTime property: Date and time (UTC) when the model was last updated." - returns: - description: "the lastUpdatedTime value." - type: "OffsetDateTime" -- uid: "com.azure.ai.anomalydetector.models.Model.getModelId()" - fullName: "com.azure.ai.anomalydetector.models.Model.getModelId()" - name: "getModelId()" - nameWithType: "Model.getModelId()" - summary: "Get the modelId property: Model identifier." - syntax: "public UUID getModelId()" - desc: "Get the modelId property: Model identifier." - returns: - description: "the modelId value." - type: "UUID" -- uid: "com.azure.ai.anomalydetector.models.Model.getModelInfo()" - fullName: "com.azure.ai.anomalydetector.models.Model.getModelInfo()" - name: "getModelInfo()" - nameWithType: "Model.getModelInfo()" - summary: "Get the modelInfo property: Train result of a model including status, errors and diagnose info for model and variables." - syntax: "public ModelInfo getModelInfo()" - desc: "Get the modelInfo property: Train result of a model including status, errors and diagnose info for model and variables." - returns: - description: "the modelInfo value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.Model.setCreatedTime(java.time.OffsetDateTime)" - fullName: "com.azure.ai.anomalydetector.models.Model.setCreatedTime(OffsetDateTime createdTime)" - name: "setCreatedTime(OffsetDateTime createdTime)" - nameWithType: "Model.setCreatedTime(OffsetDateTime createdTime)" - summary: "Set the createdTime property: Date and time (UTC) when the model was created." - parameters: - - description: "the createdTime value to set." - name: "createdTime" - type: "OffsetDateTime" - syntax: "public Model setCreatedTime(OffsetDateTime createdTime)" - desc: "Set the createdTime property: Date and time (UTC) when the model was created." - returns: - description: "the Model object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.Model.setLastUpdatedTime(java.time.OffsetDateTime)" - fullName: "com.azure.ai.anomalydetector.models.Model.setLastUpdatedTime(OffsetDateTime lastUpdatedTime)" - name: "setLastUpdatedTime(OffsetDateTime lastUpdatedTime)" - nameWithType: "Model.setLastUpdatedTime(OffsetDateTime lastUpdatedTime)" - summary: "Set the lastUpdatedTime property: Date and time (UTC) when the model was last updated." - parameters: - - description: "the lastUpdatedTime value to set." - name: "lastUpdatedTime" - type: "OffsetDateTime" - syntax: "public Model setLastUpdatedTime(OffsetDateTime lastUpdatedTime)" - desc: "Set the lastUpdatedTime property: Date and time (UTC) when the model was last updated." - returns: - description: "the Model object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.Model.setModelId(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.models.Model.setModelId(UUID modelId)" - name: "setModelId(UUID modelId)" - nameWithType: "Model.setModelId(UUID modelId)" - summary: "Set the modelId property: Model identifier." - parameters: - - description: "the modelId value to set." - name: "modelId" - type: "UUID" - syntax: "public Model setModelId(UUID modelId)" - desc: "Set the modelId property: Model identifier." - returns: - description: "the Model object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.Model.setModelInfo(com.azure.ai.anomalydetector.models.ModelInfo)" - fullName: "com.azure.ai.anomalydetector.models.Model.setModelInfo(ModelInfo modelInfo)" - name: "setModelInfo(ModelInfo modelInfo)" - nameWithType: "Model.setModelInfo(ModelInfo modelInfo)" - summary: "Set the modelInfo property: Train result of a model including status, errors and diagnose info for model and variables." - parameters: - - description: "the modelInfo value to set." - name: "modelInfo" - type: "" - syntax: "public Model setModelInfo(ModelInfo modelInfo)" - desc: "Set the modelInfo property: Train result of a model including status, errors and diagnose info for model and variables." - returns: - description: "the Model object itself." - type: "" -type: "class" -desc: "Response of getting a model." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelInfo.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelInfo.yml index c7473807d67f..30f25e3482fa 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelInfo.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelInfo.yml @@ -3,7 +3,7 @@ uid: "com.azure.ai.anomalydetector.models.ModelInfo" fullName: "com.azure.ai.anomalydetector.models.ModelInfo" name: "ModelInfo" nameWithType: "ModelInfo" -summary: "Train result of a model including status, errors and diagnose info for model and variables." +summary: "Training result of a model including its status, errors and diagnostics information." inheritances: - "" inheritedClassMethods: @@ -22,29 +22,61 @@ inheritedClassMethods: - "wait" syntax: "public final class **ModelInfo**" constructors: -- uid: "com.azure.ai.anomalydetector.models.ModelInfo.ModelInfo()" - fullName: "com.azure.ai.anomalydetector.models.ModelInfo.ModelInfo()" - name: "ModelInfo()" - nameWithType: "ModelInfo.ModelInfo()" - syntax: "public ModelInfo()" +- uid: "com.azure.ai.anomalydetector.models.ModelInfo.ModelInfo(java.lang.String,java.time.OffsetDateTime,java.time.OffsetDateTime)" + fullName: "com.azure.ai.anomalydetector.models.ModelInfo.ModelInfo(String dataSource, OffsetDateTime startTime, OffsetDateTime endTime)" + name: "ModelInfo(String dataSource, OffsetDateTime startTime, OffsetDateTime endTime)" + nameWithType: "ModelInfo.ModelInfo(String dataSource, OffsetDateTime startTime, OffsetDateTime endTime)" + summary: "Creates an instance of ModelInfo class." + parameters: + - description: "the dataSource value to set." + name: "dataSource" + type: "String" + - description: "the startTime value to set." + name: "startTime" + type: "OffsetDateTime" + - description: "the endTime value to set." + name: "endTime" + type: "OffsetDateTime" + syntax: "public ModelInfo(String dataSource, OffsetDateTime startTime, OffsetDateTime endTime)" + desc: "Creates an instance of ModelInfo class." methods: - uid: "com.azure.ai.anomalydetector.models.ModelInfo.getAlignPolicy()" fullName: "com.azure.ai.anomalydetector.models.ModelInfo.getAlignPolicy()" name: "getAlignPolicy()" nameWithType: "ModelInfo.getAlignPolicy()" - summary: "Get the alignPolicy property: The alignPolicy property." + summary: "Get the alignPolicy property: An optional field, indicating the manner to align multiple variables." syntax: "public AlignPolicy getAlignPolicy()" - desc: "Get the alignPolicy property: The alignPolicy property." + desc: "Get the alignPolicy property: An optional field, indicating the manner to align multiple variables." returns: description: "the alignPolicy value." type: "" +- uid: "com.azure.ai.anomalydetector.models.ModelInfo.getDataSchema()" + fullName: "com.azure.ai.anomalydetector.models.ModelInfo.getDataSchema()" + name: "getDataSchema()" + nameWithType: "ModelInfo.getDataSchema()" + summary: "Get the dataSchema property: Data schema of input data source: OneTable or MultiTable." + syntax: "public DataSchema getDataSchema()" + desc: "Get the dataSchema property: Data schema of input data source: OneTable or MultiTable. The default DataSchema is OneTable." + returns: + description: "the dataSchema value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.ModelInfo.getDataSource()" + fullName: "com.azure.ai.anomalydetector.models.ModelInfo.getDataSource()" + name: "getDataSource()" + nameWithType: "ModelInfo.getDataSource()" + summary: "Get the dataSource property: Source link to the input data to indicate an accessible Azure storage Uri, either pointed to an Azure blob storage folder, or pointed to a CSV file in Azure blob storage based on you data schema selection." + syntax: "public String getDataSource()" + desc: "Get the dataSource property: Source link to the input data to indicate an accessible Azure storage Uri, either pointed to an Azure blob storage folder, or pointed to a CSV file in Azure blob storage based on you data schema selection." + returns: + description: "the dataSource value." + type: "String" - uid: "com.azure.ai.anomalydetector.models.ModelInfo.getDiagnosticsInfo()" fullName: "com.azure.ai.anomalydetector.models.ModelInfo.getDiagnosticsInfo()" name: "getDiagnosticsInfo()" nameWithType: "ModelInfo.getDiagnosticsInfo()" - summary: "Get the diagnosticsInfo property: The diagnosticsInfo property." + summary: "Get the diagnosticsInfo property: Diagnostics information to help inspect the states of model or variable." syntax: "public DiagnosticsInfo getDiagnosticsInfo()" - desc: "Get the diagnosticsInfo property: The diagnosticsInfo property." + desc: "Get the diagnosticsInfo property: Diagnostics information to help inspect the states of model or variable." returns: description: "the diagnosticsInfo value." type: "" @@ -54,7 +86,7 @@ methods: nameWithType: "ModelInfo.getDisplayName()" summary: "Get the displayName property: An optional field." syntax: "public String getDisplayName()" - desc: "Get the displayName property: An optional field. The name of the model whose maximum length is 24." + desc: "Get the displayName property: An optional field. The display name of the model whose maximum length is 24 characters." returns: description: "the displayName value." type: "String" @@ -62,9 +94,9 @@ methods: fullName: "com.azure.ai.anomalydetector.models.ModelInfo.getEndTime()" name: "getEndTime()" nameWithType: "ModelInfo.getEndTime()" - summary: "Get the endTime property: A required field, indicating the end time of training data." + summary: "Get the endTime property: A required field, indicating the end time of training data, which should be date-time of ISO 8601 format." syntax: "public OffsetDateTime getEndTime()" - desc: "Get the endTime property: A required field, indicating the end time of training data. Should be date-time." + desc: "Get the endTime property: A required field, indicating the end time of training data, which should be date-time of ISO 8601 format." returns: description: "the endTime value." type: "OffsetDateTime" @@ -82,29 +114,19 @@ methods: fullName: "com.azure.ai.anomalydetector.models.ModelInfo.getSlidingWindow()" name: "getSlidingWindow()" nameWithType: "ModelInfo.getSlidingWindow()" - summary: "Get the slidingWindow property: An optional field, indicating how many previous points will be used to compute the anomaly score of the subsequent point." + summary: "Get the slidingWindow property: An optional field, indicating how many previous timestamps will be used to detect whether the timestamp is anomaly or not." syntax: "public Integer getSlidingWindow()" - desc: "Get the slidingWindow property: An optional field, indicating how many previous points will be used to compute the anomaly score of the subsequent point." + desc: "Get the slidingWindow property: An optional field, indicating how many previous timestamps will be used to detect whether the timestamp is anomaly or not." returns: description: "the slidingWindow value." type: "Integer" -- uid: "com.azure.ai.anomalydetector.models.ModelInfo.getSource()" - fullName: "com.azure.ai.anomalydetector.models.ModelInfo.getSource()" - name: "getSource()" - nameWithType: "ModelInfo.getSource()" - summary: "Get the source property: Source link to the input variables." - syntax: "public String getSource()" - desc: "Get the source property: Source link to the input variables. Each variable should be a csv file with two columns, \\`timestamp\\` and \\`value\\`. By default, the file name of the variable will be used as its variable name." - returns: - description: "the source value." - type: "String" - uid: "com.azure.ai.anomalydetector.models.ModelInfo.getStartTime()" fullName: "com.azure.ai.anomalydetector.models.ModelInfo.getStartTime()" name: "getStartTime()" nameWithType: "ModelInfo.getStartTime()" - summary: "Get the startTime property: A required field, indicating the start time of training data." + summary: "Get the startTime property: A required field, indicating the start time of training data, which should be date-time of ISO 8601 format." syntax: "public OffsetDateTime getStartTime()" - desc: "Get the startTime property: A required field, indicating the start time of training data. Should be date-time." + desc: "Get the startTime property: A required field, indicating the start time of training data, which should be date-time of ISO 8601 format." returns: description: "the startTime value." type: "OffsetDateTime" @@ -112,9 +134,9 @@ methods: fullName: "com.azure.ai.anomalydetector.models.ModelInfo.getStatus()" name: "getStatus()" nameWithType: "ModelInfo.getStatus()" - summary: "Get the status property: Model training status." + summary: "Get the status property: Model status." syntax: "public ModelStatus getStatus()" - desc: "Get the status property: Model training status." + desc: "Get the status property: Model status. One of CREATED, RUNNING, READY, and FAILED." returns: description: "the status value." type: "" @@ -122,13 +144,41 @@ methods: fullName: "com.azure.ai.anomalydetector.models.ModelInfo.setAlignPolicy(AlignPolicy alignPolicy)" name: "setAlignPolicy(AlignPolicy alignPolicy)" nameWithType: "ModelInfo.setAlignPolicy(AlignPolicy alignPolicy)" - summary: "Set the alignPolicy property: The alignPolicy property." + summary: "Set the alignPolicy property: An optional field, indicating the manner to align multiple variables." parameters: - description: "the alignPolicy value to set." name: "alignPolicy" type: "" syntax: "public ModelInfo setAlignPolicy(AlignPolicy alignPolicy)" - desc: "Set the alignPolicy property: The alignPolicy property." + desc: "Set the alignPolicy property: An optional field, indicating the manner to align multiple variables." + returns: + description: "the ModelInfo object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.ModelInfo.setDataSchema(com.azure.ai.anomalydetector.models.DataSchema)" + fullName: "com.azure.ai.anomalydetector.models.ModelInfo.setDataSchema(DataSchema dataSchema)" + name: "setDataSchema(DataSchema dataSchema)" + nameWithType: "ModelInfo.setDataSchema(DataSchema dataSchema)" + summary: "Set the dataSchema property: Data schema of input data source: OneTable or MultiTable." + parameters: + - description: "the dataSchema value to set." + name: "dataSchema" + type: "" + syntax: "public ModelInfo setDataSchema(DataSchema dataSchema)" + desc: "Set the dataSchema property: Data schema of input data source: OneTable or MultiTable. The default DataSchema is OneTable." + returns: + description: "the ModelInfo object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.ModelInfo.setDiagnosticsInfo(com.azure.ai.anomalydetector.models.DiagnosticsInfo)" + fullName: "com.azure.ai.anomalydetector.models.ModelInfo.setDiagnosticsInfo(DiagnosticsInfo diagnosticsInfo)" + name: "setDiagnosticsInfo(DiagnosticsInfo diagnosticsInfo)" + nameWithType: "ModelInfo.setDiagnosticsInfo(DiagnosticsInfo diagnosticsInfo)" + summary: "Set the diagnosticsInfo property: Diagnostics information to help inspect the states of model or variable." + parameters: + - description: "the diagnosticsInfo value to set." + name: "diagnosticsInfo" + type: "" + syntax: "public ModelInfo setDiagnosticsInfo(DiagnosticsInfo diagnosticsInfo)" + desc: "Set the diagnosticsInfo property: Diagnostics information to help inspect the states of model or variable." returns: description: "the ModelInfo object itself." type: "" @@ -142,21 +192,7 @@ methods: name: "displayName" type: "String" syntax: "public ModelInfo setDisplayName(String displayName)" - desc: "Set the displayName property: An optional field. The name of the model whose maximum length is 24." - returns: - description: "the ModelInfo object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelInfo.setEndTime(java.time.OffsetDateTime)" - fullName: "com.azure.ai.anomalydetector.models.ModelInfo.setEndTime(OffsetDateTime endTime)" - name: "setEndTime(OffsetDateTime endTime)" - nameWithType: "ModelInfo.setEndTime(OffsetDateTime endTime)" - summary: "Set the endTime property: A required field, indicating the end time of training data." - parameters: - - description: "the endTime value to set." - name: "endTime" - type: "OffsetDateTime" - syntax: "public ModelInfo setEndTime(OffsetDateTime endTime)" - desc: "Set the endTime property: A required field, indicating the end time of training data. Should be date-time." + desc: "Set the displayName property: An optional field. The display name of the model whose maximum length is 24 characters." returns: description: "the ModelInfo object itself." type: "" @@ -164,46 +200,32 @@ methods: fullName: "com.azure.ai.anomalydetector.models.ModelInfo.setSlidingWindow(Integer slidingWindow)" name: "setSlidingWindow(Integer slidingWindow)" nameWithType: "ModelInfo.setSlidingWindow(Integer slidingWindow)" - summary: "Set the slidingWindow property: An optional field, indicating how many previous points will be used to compute the anomaly score of the subsequent point." + summary: "Set the slidingWindow property: An optional field, indicating how many previous timestamps will be used to detect whether the timestamp is anomaly or not." parameters: - description: "the slidingWindow value to set." name: "slidingWindow" type: "Integer" syntax: "public ModelInfo setSlidingWindow(Integer slidingWindow)" - desc: "Set the slidingWindow property: An optional field, indicating how many previous points will be used to compute the anomaly score of the subsequent point." + desc: "Set the slidingWindow property: An optional field, indicating how many previous timestamps will be used to detect whether the timestamp is anomaly or not." returns: description: "the ModelInfo object itself." type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelInfo.setSource(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.ModelInfo.setSource(String source)" - name: "setSource(String source)" - nameWithType: "ModelInfo.setSource(String source)" - summary: "Set the source property: Source link to the input variables." +- uid: "com.azure.ai.anomalydetector.models.ModelInfo.setStatus(com.azure.ai.anomalydetector.models.ModelStatus)" + fullName: "com.azure.ai.anomalydetector.models.ModelInfo.setStatus(ModelStatus status)" + name: "setStatus(ModelStatus status)" + nameWithType: "ModelInfo.setStatus(ModelStatus status)" + summary: "Set the status property: Model status." parameters: - - description: "the source value to set." - name: "source" - type: "String" - syntax: "public ModelInfo setSource(String source)" - desc: "Set the source property: Source link to the input variables. Each variable should be a csv file with two columns, \\`timestamp\\` and \\`value\\`. By default, the file name of the variable will be used as its variable name." - returns: - description: "the ModelInfo object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelInfo.setStartTime(java.time.OffsetDateTime)" - fullName: "com.azure.ai.anomalydetector.models.ModelInfo.setStartTime(OffsetDateTime startTime)" - name: "setStartTime(OffsetDateTime startTime)" - nameWithType: "ModelInfo.setStartTime(OffsetDateTime startTime)" - summary: "Set the startTime property: A required field, indicating the start time of training data." - parameters: - - description: "the startTime value to set." - name: "startTime" - type: "OffsetDateTime" - syntax: "public ModelInfo setStartTime(OffsetDateTime startTime)" - desc: "Set the startTime property: A required field, indicating the start time of training data. Should be date-time." + - description: "the status value to set." + name: "status" + type: "" + syntax: "public ModelInfo setStatus(ModelStatus status)" + desc: "Set the status property: Model status. One of CREATED, RUNNING, READY, and FAILED." returns: description: "the ModelInfo object itself." type: "" type: "class" -desc: "Train result of a model including status, errors and diagnose info for model and variables." +desc: "Training result of a model including its status, errors and diagnostics information." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelList.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelList.yml deleted file mode 100644 index 665d21b35d8d..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelList.yml +++ /dev/null @@ -1,131 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.ModelList" -fullName: "com.azure.ai.anomalydetector.models.ModelList" -name: "ModelList" -nameWithType: "ModelList" -summary: "Response of listing models." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **ModelList**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.ModelList.ModelList()" - fullName: "com.azure.ai.anomalydetector.models.ModelList.ModelList()" - name: "ModelList()" - nameWithType: "ModelList.ModelList()" - syntax: "public ModelList()" -methods: -- uid: "com.azure.ai.anomalydetector.models.ModelList.getCurrentCount()" - fullName: "com.azure.ai.anomalydetector.models.ModelList.getCurrentCount()" - name: "getCurrentCount()" - nameWithType: "ModelList.getCurrentCount()" - summary: "Get the currentCount property: Current count of trained multivariate models." - syntax: "public int getCurrentCount()" - desc: "Get the currentCount property: Current count of trained multivariate models." - returns: - description: "the currentCount value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelList.getMaxCount()" - fullName: "com.azure.ai.anomalydetector.models.ModelList.getMaxCount()" - name: "getMaxCount()" - nameWithType: "ModelList.getMaxCount()" - summary: "Get the maxCount property: Max number of models that can be trained for this subscription." - syntax: "public int getMaxCount()" - desc: "Get the maxCount property: Max number of models that can be trained for this subscription." - returns: - description: "the maxCount value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelList.getModels()" - fullName: "com.azure.ai.anomalydetector.models.ModelList.getModels()" - name: "getModels()" - nameWithType: "ModelList.getModels()" - summary: "Get the models property: List of models." - syntax: "public List getModels()" - desc: "Get the models property: List of models." - returns: - description: "the models value." - type: "List<>" -- uid: "com.azure.ai.anomalydetector.models.ModelList.getNextLink()" - fullName: "com.azure.ai.anomalydetector.models.ModelList.getNextLink()" - name: "getNextLink()" - nameWithType: "ModelList.getNextLink()" - summary: "Get the nextLink property: The link to fetch more models." - syntax: "public String getNextLink()" - desc: "Get the nextLink property: The link to fetch more models." - returns: - description: "the nextLink value." - type: "String" -- uid: "com.azure.ai.anomalydetector.models.ModelList.setCurrentCount(int)" - fullName: "com.azure.ai.anomalydetector.models.ModelList.setCurrentCount(int currentCount)" - name: "setCurrentCount(int currentCount)" - nameWithType: "ModelList.setCurrentCount(int currentCount)" - summary: "Set the currentCount property: Current count of trained multivariate models." - parameters: - - description: "the currentCount value to set." - name: "currentCount" - type: "" - syntax: "public ModelList setCurrentCount(int currentCount)" - desc: "Set the currentCount property: Current count of trained multivariate models." - returns: - description: "the ModelList object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelList.setMaxCount(int)" - fullName: "com.azure.ai.anomalydetector.models.ModelList.setMaxCount(int maxCount)" - name: "setMaxCount(int maxCount)" - nameWithType: "ModelList.setMaxCount(int maxCount)" - summary: "Set the maxCount property: Max number of models that can be trained for this subscription." - parameters: - - description: "the maxCount value to set." - name: "maxCount" - type: "" - syntax: "public ModelList setMaxCount(int maxCount)" - desc: "Set the maxCount property: Max number of models that can be trained for this subscription." - returns: - description: "the ModelList object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelList.setModels(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.ModelList.setModels(List models)" - name: "setModels(List models)" - nameWithType: "ModelList.setModels(List models)" - summary: "Set the models property: List of models." - parameters: - - description: "the models value to set." - name: "models" - type: "List<>" - syntax: "public ModelList setModels(List models)" - desc: "Set the models property: List of models." - returns: - description: "the ModelList object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelList.setNextLink(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.ModelList.setNextLink(String nextLink)" - name: "setNextLink(String nextLink)" - nameWithType: "ModelList.setNextLink(String nextLink)" - summary: "Set the nextLink property: The link to fetch more models." - parameters: - - description: "the nextLink value to set." - name: "nextLink" - type: "String" - syntax: "public ModelList setNextLink(String nextLink)" - desc: "Set the nextLink property: The link to fetch more models." - returns: - description: "the ModelList object itself." - type: "" -type: "class" -desc: "Response of listing models." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelSnapshot.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelSnapshot.yml deleted file mode 100644 index 4c7498870a9c..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelSnapshot.yml +++ /dev/null @@ -1,165 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.ModelSnapshot" -fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot" -name: "ModelSnapshot" -nameWithType: "ModelSnapshot" -summary: "The ModelSnapshot model." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **ModelSnapshot**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.ModelSnapshot()" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.ModelSnapshot()" - name: "ModelSnapshot()" - nameWithType: "ModelSnapshot.ModelSnapshot()" - syntax: "public ModelSnapshot()" -methods: -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.getCreatedTime()" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.getCreatedTime()" - name: "getCreatedTime()" - nameWithType: "ModelSnapshot.getCreatedTime()" - summary: "Get the createdTime property: Date and time (UTC) when the model was created." - syntax: "public OffsetDateTime getCreatedTime()" - desc: "Get the createdTime property: Date and time (UTC) when the model was created." - returns: - description: "the createdTime value." - type: "OffsetDateTime" -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.getDisplayName()" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.getDisplayName()" - name: "getDisplayName()" - nameWithType: "ModelSnapshot.getDisplayName()" - summary: "Get the displayName property: The displayName property." - syntax: "public String getDisplayName()" - desc: "Get the displayName property: The displayName property." - returns: - description: "the displayName value." - type: "String" -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.getLastUpdatedTime()" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.getLastUpdatedTime()" - name: "getLastUpdatedTime()" - nameWithType: "ModelSnapshot.getLastUpdatedTime()" - summary: "Get the lastUpdatedTime property: Date and time (UTC) when the model was last updated." - syntax: "public OffsetDateTime getLastUpdatedTime()" - desc: "Get the lastUpdatedTime property: Date and time (UTC) when the model was last updated." - returns: - description: "the lastUpdatedTime value." - type: "OffsetDateTime" -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.getModelId()" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.getModelId()" - name: "getModelId()" - nameWithType: "ModelSnapshot.getModelId()" - summary: "Get the modelId property: Model identifier." - syntax: "public UUID getModelId()" - desc: "Get the modelId property: Model identifier." - returns: - description: "the modelId value." - type: "UUID" -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.getStatus()" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.getStatus()" - name: "getStatus()" - nameWithType: "ModelSnapshot.getStatus()" - summary: "Get the status property: Model training status." - syntax: "public ModelStatus getStatus()" - desc: "Get the status property: Model training status." - returns: - description: "the status value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.getVariablesCount()" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.getVariablesCount()" - name: "getVariablesCount()" - nameWithType: "ModelSnapshot.getVariablesCount()" - summary: "Get the variablesCount property: Total number of variables." - syntax: "public int getVariablesCount()" - desc: "Get the variablesCount property: Total number of variables." - returns: - description: "the variablesCount value." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.setCreatedTime(java.time.OffsetDateTime)" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.setCreatedTime(OffsetDateTime createdTime)" - name: "setCreatedTime(OffsetDateTime createdTime)" - nameWithType: "ModelSnapshot.setCreatedTime(OffsetDateTime createdTime)" - summary: "Set the createdTime property: Date and time (UTC) when the model was created." - parameters: - - description: "the createdTime value to set." - name: "createdTime" - type: "OffsetDateTime" - syntax: "public ModelSnapshot setCreatedTime(OffsetDateTime createdTime)" - desc: "Set the createdTime property: Date and time (UTC) when the model was created." - returns: - description: "the ModelSnapshot object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.setDisplayName(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.setDisplayName(String displayName)" - name: "setDisplayName(String displayName)" - nameWithType: "ModelSnapshot.setDisplayName(String displayName)" - summary: "Set the displayName property: The displayName property." - parameters: - - description: "the displayName value to set." - name: "displayName" - type: "String" - syntax: "public ModelSnapshot setDisplayName(String displayName)" - desc: "Set the displayName property: The displayName property." - returns: - description: "the ModelSnapshot object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.setLastUpdatedTime(java.time.OffsetDateTime)" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.setLastUpdatedTime(OffsetDateTime lastUpdatedTime)" - name: "setLastUpdatedTime(OffsetDateTime lastUpdatedTime)" - nameWithType: "ModelSnapshot.setLastUpdatedTime(OffsetDateTime lastUpdatedTime)" - summary: "Set the lastUpdatedTime property: Date and time (UTC) when the model was last updated." - parameters: - - description: "the lastUpdatedTime value to set." - name: "lastUpdatedTime" - type: "OffsetDateTime" - syntax: "public ModelSnapshot setLastUpdatedTime(OffsetDateTime lastUpdatedTime)" - desc: "Set the lastUpdatedTime property: Date and time (UTC) when the model was last updated." - returns: - description: "the ModelSnapshot object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.setModelId(java.util.UUID)" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.setModelId(UUID modelId)" - name: "setModelId(UUID modelId)" - nameWithType: "ModelSnapshot.setModelId(UUID modelId)" - summary: "Set the modelId property: Model identifier." - parameters: - - description: "the modelId value to set." - name: "modelId" - type: "UUID" - syntax: "public ModelSnapshot setModelId(UUID modelId)" - desc: "Set the modelId property: Model identifier." - returns: - description: "the ModelSnapshot object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelSnapshot.setVariablesCount(int)" - fullName: "com.azure.ai.anomalydetector.models.ModelSnapshot.setVariablesCount(int variablesCount)" - name: "setVariablesCount(int variablesCount)" - nameWithType: "ModelSnapshot.setVariablesCount(int variablesCount)" - summary: "Set the variablesCount property: Total number of variables." - parameters: - - description: "the variablesCount value to set." - name: "variablesCount" - type: "" - syntax: "public ModelSnapshot setVariablesCount(int variablesCount)" - desc: "Set the variablesCount property: Total number of variables." - returns: - description: "the ModelSnapshot object itself." - type: "" -type: "class" -desc: "The ModelSnapshot model." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelState.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelState.yml index 427419ce106c..41f28be61e99 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelState.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelState.yml @@ -3,7 +3,7 @@ uid: "com.azure.ai.anomalydetector.models.ModelState" fullName: "com.azure.ai.anomalydetector.models.ModelState" name: "ModelState" nameWithType: "ModelState" -summary: "The ModelState model." +summary: "Model status." inheritances: - "" inheritedClassMethods: @@ -26,15 +26,17 @@ constructors: fullName: "com.azure.ai.anomalydetector.models.ModelState.ModelState()" name: "ModelState()" nameWithType: "ModelState.ModelState()" + summary: "Creates an instance of ModelState class." syntax: "public ModelState()" + desc: "Creates an instance of ModelState class." methods: - uid: "com.azure.ai.anomalydetector.models.ModelState.getEpochIds()" fullName: "com.azure.ai.anomalydetector.models.ModelState.getEpochIds()" name: "getEpochIds()" nameWithType: "ModelState.getEpochIds()" - summary: "Get the epochIds property: Epoch id." + summary: "Get the epochIds property: This indicates the number of passes of the entire training dataset the algorithm has completed." syntax: "public List getEpochIds()" - desc: "Get the epochIds property: Epoch id." + desc: "Get the epochIds property: This indicates the number of passes of the entire training dataset the algorithm has completed." returns: description: "the epochIds value." type: "List<Integer>" @@ -42,90 +44,90 @@ methods: fullName: "com.azure.ai.anomalydetector.models.ModelState.getLatenciesInSeconds()" name: "getLatenciesInSeconds()" nameWithType: "ModelState.getLatenciesInSeconds()" - summary: "Get the latenciesInSeconds property: The latenciesInSeconds property." - syntax: "public List getLatenciesInSeconds()" - desc: "Get the latenciesInSeconds property: The latenciesInSeconds property." + summary: "Get the latenciesInSeconds property: Latency for each epoch." + syntax: "public List getLatenciesInSeconds()" + desc: "Get the latenciesInSeconds property: Latency for each epoch." returns: description: "the latenciesInSeconds value." - type: "List<Float>" + type: "List<Double>" - uid: "com.azure.ai.anomalydetector.models.ModelState.getTrainLosses()" fullName: "com.azure.ai.anomalydetector.models.ModelState.getTrainLosses()" name: "getTrainLosses()" nameWithType: "ModelState.getTrainLosses()" - summary: "Get the trainLosses property: The trainLosses property." - syntax: "public List getTrainLosses()" - desc: "Get the trainLosses property: The trainLosses property." + summary: "Get the trainLosses property: List of metrics used to assess how the model fits the training data for each epoch." + syntax: "public List getTrainLosses()" + desc: "Get the trainLosses property: List of metrics used to assess how the model fits the training data for each epoch." returns: description: "the trainLosses value." - type: "List<Float>" + type: "List<Double>" - uid: "com.azure.ai.anomalydetector.models.ModelState.getValidationLosses()" fullName: "com.azure.ai.anomalydetector.models.ModelState.getValidationLosses()" name: "getValidationLosses()" nameWithType: "ModelState.getValidationLosses()" - summary: "Get the validationLosses property: The validationLosses property." - syntax: "public List getValidationLosses()" - desc: "Get the validationLosses property: The validationLosses property." + summary: "Get the validationLosses property: List of metrics used to assess how the model fits the validation set for each epoch." + syntax: "public List getValidationLosses()" + desc: "Get the validationLosses property: List of metrics used to assess how the model fits the validation set for each epoch." returns: description: "the validationLosses value." - type: "List<Float>" + type: "List<Double>" - uid: "com.azure.ai.anomalydetector.models.ModelState.setEpochIds(java.util.List)" fullName: "com.azure.ai.anomalydetector.models.ModelState.setEpochIds(List epochIds)" name: "setEpochIds(List epochIds)" nameWithType: "ModelState.setEpochIds(List epochIds)" - summary: "Set the epochIds property: Epoch id." + summary: "Set the epochIds property: This indicates the number of passes of the entire training dataset the algorithm has completed." parameters: - description: "the epochIds value to set." name: "epochIds" type: "List<Integer>" syntax: "public ModelState setEpochIds(List epochIds)" - desc: "Set the epochIds property: Epoch id." + desc: "Set the epochIds property: This indicates the number of passes of the entire training dataset the algorithm has completed." returns: description: "the ModelState object itself." type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelState.setLatenciesInSeconds(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.ModelState.setLatenciesInSeconds(List latenciesInSeconds)" - name: "setLatenciesInSeconds(List latenciesInSeconds)" - nameWithType: "ModelState.setLatenciesInSeconds(List latenciesInSeconds)" - summary: "Set the latenciesInSeconds property: The latenciesInSeconds property." +- uid: "com.azure.ai.anomalydetector.models.ModelState.setLatenciesInSeconds(java.util.List)" + fullName: "com.azure.ai.anomalydetector.models.ModelState.setLatenciesInSeconds(List latenciesInSeconds)" + name: "setLatenciesInSeconds(List latenciesInSeconds)" + nameWithType: "ModelState.setLatenciesInSeconds(List latenciesInSeconds)" + summary: "Set the latenciesInSeconds property: Latency for each epoch." parameters: - description: "the latenciesInSeconds value to set." name: "latenciesInSeconds" - type: "List<Float>" - syntax: "public ModelState setLatenciesInSeconds(List latenciesInSeconds)" - desc: "Set the latenciesInSeconds property: The latenciesInSeconds property." + type: "List<Double>" + syntax: "public ModelState setLatenciesInSeconds(List latenciesInSeconds)" + desc: "Set the latenciesInSeconds property: Latency for each epoch." returns: description: "the ModelState object itself." type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelState.setTrainLosses(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.ModelState.setTrainLosses(List trainLosses)" - name: "setTrainLosses(List trainLosses)" - nameWithType: "ModelState.setTrainLosses(List trainLosses)" - summary: "Set the trainLosses property: The trainLosses property." +- uid: "com.azure.ai.anomalydetector.models.ModelState.setTrainLosses(java.util.List)" + fullName: "com.azure.ai.anomalydetector.models.ModelState.setTrainLosses(List trainLosses)" + name: "setTrainLosses(List trainLosses)" + nameWithType: "ModelState.setTrainLosses(List trainLosses)" + summary: "Set the trainLosses property: List of metrics used to assess how the model fits the training data for each epoch." parameters: - description: "the trainLosses value to set." name: "trainLosses" - type: "List<Float>" - syntax: "public ModelState setTrainLosses(List trainLosses)" - desc: "Set the trainLosses property: The trainLosses property." + type: "List<Double>" + syntax: "public ModelState setTrainLosses(List trainLosses)" + desc: "Set the trainLosses property: List of metrics used to assess how the model fits the training data for each epoch." returns: description: "the ModelState object itself." type: "" -- uid: "com.azure.ai.anomalydetector.models.ModelState.setValidationLosses(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.ModelState.setValidationLosses(List validationLosses)" - name: "setValidationLosses(List validationLosses)" - nameWithType: "ModelState.setValidationLosses(List validationLosses)" - summary: "Set the validationLosses property: The validationLosses property." +- uid: "com.azure.ai.anomalydetector.models.ModelState.setValidationLosses(java.util.List)" + fullName: "com.azure.ai.anomalydetector.models.ModelState.setValidationLosses(List validationLosses)" + name: "setValidationLosses(List validationLosses)" + nameWithType: "ModelState.setValidationLosses(List validationLosses)" + summary: "Set the validationLosses property: List of metrics used to assess how the model fits the validation set for each epoch." parameters: - description: "the validationLosses value to set." name: "validationLosses" - type: "List<Float>" - syntax: "public ModelState setValidationLosses(List validationLosses)" - desc: "Set the validationLosses property: The validationLosses property." + type: "List<Double>" + syntax: "public ModelState setValidationLosses(List validationLosses)" + desc: "Set the validationLosses property: List of metrics used to assess how the model fits the validation set for each epoch." returns: description: "the ModelState object itself." type: "" type: "class" -desc: "The ModelState model." +desc: "Model status." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelStatus.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelStatus.yml index 87052bfbe441..ea7ae15f7292 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelStatus.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ModelStatus.yml @@ -103,4 +103,4 @@ methods: desc: "Defines values for ModelStatus." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.yml new file mode 100644 index 000000000000..eaef962847e3 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.yml @@ -0,0 +1,90 @@ +### YamlMime:JavaType +uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions" +fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions" +name: "MultivariateBatchDetectionOptions" +nameWithType: "MultivariateBatchDetectionOptions" +summary: "Detection request for batch inference." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **MultivariateBatchDetectionOptions**" +constructors: +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.MultivariateBatchDetectionOptions(java.lang.String,int,java.time.OffsetDateTime,java.time.OffsetDateTime)" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.MultivariateBatchDetectionOptions(String dataSource, int topContributorCount, OffsetDateTime startTime, OffsetDateTime endTime)" + name: "MultivariateBatchDetectionOptions(String dataSource, int topContributorCount, OffsetDateTime startTime, OffsetDateTime endTime)" + nameWithType: "MultivariateBatchDetectionOptions.MultivariateBatchDetectionOptions(String dataSource, int topContributorCount, OffsetDateTime startTime, OffsetDateTime endTime)" + summary: "Creates an instance of MultivariateBatchDetectionOptions class." + parameters: + - description: "the dataSource value to set." + name: "dataSource" + type: "String" + - description: "the topContributorCount value to set." + name: "topContributorCount" + type: "" + - description: "the startTime value to set." + name: "startTime" + type: "OffsetDateTime" + - description: "the endTime value to set." + name: "endTime" + type: "OffsetDateTime" + syntax: "public MultivariateBatchDetectionOptions(String dataSource, int topContributorCount, OffsetDateTime startTime, OffsetDateTime endTime)" + desc: "Creates an instance of MultivariateBatchDetectionOptions class." +methods: +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.getDataSource()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.getDataSource()" + name: "getDataSource()" + nameWithType: "MultivariateBatchDetectionOptions.getDataSource()" + summary: "Get the dataSource property: Source link to the input data to indicate an accessible Azure storage Uri, either pointed to an Azure blob storage folder, or pointed to a CSV file in Azure blob storage based on you data schema selection." + syntax: "public String getDataSource()" + desc: "Get the dataSource property: Source link to the input data to indicate an accessible Azure storage Uri, either pointed to an Azure blob storage folder, or pointed to a CSV file in Azure blob storage based on you data schema selection. The data schema should be exactly the same with those used in the training phase." + returns: + description: "the dataSource value." + type: "String" +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.getEndTime()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.getEndTime()" + name: "getEndTime()" + nameWithType: "MultivariateBatchDetectionOptions.getEndTime()" + summary: "Get the endTime property: A required field, indicating the end time of data for detection, which should be date-time of ISO 8601 format." + syntax: "public OffsetDateTime getEndTime()" + desc: "Get the endTime property: A required field, indicating the end time of data for detection, which should be date-time of ISO 8601 format." + returns: + description: "the endTime value." + type: "OffsetDateTime" +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.getStartTime()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.getStartTime()" + name: "getStartTime()" + nameWithType: "MultivariateBatchDetectionOptions.getStartTime()" + summary: "Get the startTime property: A required field, indicating the start time of data for detection, which should be date-time of ISO 8601 format." + syntax: "public OffsetDateTime getStartTime()" + desc: "Get the startTime property: A required field, indicating the start time of data for detection, which should be date-time of ISO 8601 format." + returns: + description: "the startTime value." + type: "OffsetDateTime" +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.getTopContributorCount()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions.getTopContributorCount()" + name: "getTopContributorCount()" + nameWithType: "MultivariateBatchDetectionOptions.getTopContributorCount()" + summary: "Get the topContributorCount property: An optional field, which is used to specify the number of top contributed variables for one anomalous timestamp in the response." + syntax: "public int getTopContributorCount()" + desc: "Get the topContributorCount property: An optional field, which is used to specify the number of top contributed variables for one anomalous timestamp in the response. The default number is 10." + returns: + description: "the topContributorCount value." + type: "" +type: "class" +desc: "Detection request for batch inference. This is an asynchronous inference which will need another API to get detection results." +metadata: {} +package: "com.azure.ai.anomalydetector.models" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.yml new file mode 100644 index 000000000000..5c728b25bf5c --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.yml @@ -0,0 +1,69 @@ +### YamlMime:JavaType +uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary" +fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary" +name: "MultivariateBatchDetectionResultSummary" +nameWithType: "MultivariateBatchDetectionResultSummary" +summary: "Multivariate anomaly detection status." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **MultivariateBatchDetectionResultSummary**" +methods: +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.getErrors()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.getErrors()" + name: "getErrors()" + nameWithType: "MultivariateBatchDetectionResultSummary.getErrors()" + summary: "Get the errors property: Error message when detection is failed." + syntax: "public List getErrors()" + desc: "Get the errors property: Error message when detection is failed." + returns: + description: "the errors value." + type: "List<>" +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.getSetupInfo()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.getSetupInfo()" + name: "getSetupInfo()" + nameWithType: "MultivariateBatchDetectionResultSummary.getSetupInfo()" + summary: "Get the setupInfo property: Detection request for batch inference." + syntax: "public MultivariateBatchDetectionOptions getSetupInfo()" + desc: "Get the setupInfo property: Detection request for batch inference. This is an asynchronous inference which will need another API to get detection results." + returns: + description: "the setupInfo value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.getStatus()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.getStatus()" + name: "getStatus()" + nameWithType: "MultivariateBatchDetectionResultSummary.getStatus()" + summary: "Get the status property: Status of detection results." + syntax: "public MultivariateBatchDetectionStatus getStatus()" + desc: "Get the status property: Status of detection results. One of CREATED, RUNNING, READY, and FAILED." + returns: + description: "the status value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.getVariableStates()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary.getVariableStates()" + name: "getVariableStates()" + nameWithType: "MultivariateBatchDetectionResultSummary.getVariableStates()" + summary: "Get the variableStates property: Variable Status." + syntax: "public List getVariableStates()" + desc: "Get the variableStates property: Variable Status." + returns: + description: "the variableStates value." + type: "List<>" +type: "class" +desc: "Multivariate anomaly detection status." +metadata: {} +package: "com.azure.ai.anomalydetector.models" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.yml new file mode 100644 index 000000000000..82e4e1bfc570 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.yml @@ -0,0 +1,106 @@ +### YamlMime:JavaEnum +uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus" +fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus" +name: "MultivariateBatchDetectionStatus" +nameWithType: "MultivariateBatchDetectionStatus" +summary: "Defines values for MultivariateBatchDetectionStatus." +inheritances: +- "" +- "" +inheritedClassMethods: +- classRef: "java.lang.Enum" + methodsRef: + - "valueOf-java.lang.Class-java.lang.String-\">valueOf" + - "clone" + - "compareTo" + - "equals" + - "finalize" + - "getDeclaringClass" + - "hashCode" + - "name" + - "ordinal" + - "toString" +- classRef: "java.lang.Object" + methodsRef: + - "getClass" + - "notify" + - "notifyAll" + - "wait" + - "wait" + - "wait" +syntax: "public enum **MultivariateBatchDetectionStatus**
extends Enum<>" +fields: +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.CREATED" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.CREATED" + name: "CREATED" + nameWithType: "MultivariateBatchDetectionStatus.CREATED" + summary: "Enum value CREATED." + desc: "Enum value CREATED." +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.FAILED" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.FAILED" + name: "FAILED" + nameWithType: "MultivariateBatchDetectionStatus.FAILED" + summary: "Enum value FAILED." + desc: "Enum value FAILED." +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.READY" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.READY" + name: "READY" + nameWithType: "MultivariateBatchDetectionStatus.READY" + summary: "Enum value READY." + desc: "Enum value READY." +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.RUNNING" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.RUNNING" + name: "RUNNING" + nameWithType: "MultivariateBatchDetectionStatus.RUNNING" + summary: "Enum value RUNNING." + desc: "Enum value RUNNING." +methods: +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.fromString(java.lang.String)" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.fromString(String value)" + name: "fromString(String value)" + nameWithType: "MultivariateBatchDetectionStatus.fromString(String value)" + summary: "Parses a serialized value to a MultivariateBatchDetectionStatus instance." + modifiers: + - "static" + parameters: + - description: "the serialized value to parse." + name: "value" + type: "String" + syntax: "public static MultivariateBatchDetectionStatus fromString(String value)" + desc: "Parses a serialized value to a MultivariateBatchDetectionStatus instance." + returns: + description: "the parsed MultivariateBatchDetectionStatus object, or null if unable to parse." + type: "" +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.toString()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.toString()" + name: "toString()" + nameWithType: "MultivariateBatchDetectionStatus.toString()" + overridden: "java.lang.Enum.toString()" + syntax: "public String toString()" + returns: + type: "String" +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.valueOf(java.lang.String)" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.valueOf(String name)" + name: "valueOf(String name)" + nameWithType: "MultivariateBatchDetectionStatus.valueOf(String name)" + modifiers: + - "static" + parameters: + - name: "name" + type: "String" + syntax: "public static MultivariateBatchDetectionStatus valueOf(String name)" + returns: + type: "" +- uid: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.values()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus.values()" + name: "values()" + nameWithType: "MultivariateBatchDetectionStatus.values()" + modifiers: + - "static" + syntax: "public static MultivariateBatchDetectionStatus[] values()" + returns: + type: "[]" +desc: "Defines values for MultivariateBatchDetectionStatus." +metadata: {} +package: "com.azure.ai.anomalydetector.models" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateDetectionResult.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateDetectionResult.yml new file mode 100644 index 000000000000..acfd40afa284 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateDetectionResult.yml @@ -0,0 +1,59 @@ +### YamlMime:JavaType +uid: "com.azure.ai.anomalydetector.models.MultivariateDetectionResult" +fullName: "com.azure.ai.anomalydetector.models.MultivariateDetectionResult" +name: "MultivariateDetectionResult" +nameWithType: "MultivariateDetectionResult" +summary: "Detection results for the given resultId." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **MultivariateDetectionResult**" +methods: +- uid: "com.azure.ai.anomalydetector.models.MultivariateDetectionResult.getResultId()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateDetectionResult.getResultId()" + name: "getResultId()" + nameWithType: "MultivariateDetectionResult.getResultId()" + summary: "Get the resultId property: Result identifier, which is used to fetch the results of an inference call." + syntax: "public String getResultId()" + desc: "Get the resultId property: Result identifier, which is used to fetch the results of an inference call." + returns: + description: "the resultId value." + type: "String" +- uid: "com.azure.ai.anomalydetector.models.MultivariateDetectionResult.getResults()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateDetectionResult.getResults()" + name: "getResults()" + nameWithType: "MultivariateDetectionResult.getResults()" + summary: "Get the results property: Detection result for each timestamp." + syntax: "public List getResults()" + desc: "Get the results property: Detection result for each timestamp." + returns: + description: "the results value." + type: "List<>" +- uid: "com.azure.ai.anomalydetector.models.MultivariateDetectionResult.getSummary()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateDetectionResult.getSummary()" + name: "getSummary()" + nameWithType: "MultivariateDetectionResult.getSummary()" + summary: "Get the summary property: Multivariate anomaly detection status." + syntax: "public MultivariateBatchDetectionResultSummary getSummary()" + desc: "Get the summary property: Multivariate anomaly detection status." + returns: + description: "the summary value." + type: "" +type: "class" +desc: "Detection results for the given resultId." +metadata: {} +package: "com.azure.ai.anomalydetector.models" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions.yml new file mode 100644 index 000000000000..11af7954391a --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions.yml @@ -0,0 +1,64 @@ +### YamlMime:JavaType +uid: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions" +fullName: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions" +name: "MultivariateLastDetectionOptions" +nameWithType: "MultivariateLastDetectionOptions" +summary: "Request of last detection." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **MultivariateLastDetectionOptions**" +constructors: +- uid: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions.MultivariateLastDetectionOptions(java.util.List,int)" + fullName: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions.MultivariateLastDetectionOptions(List variables, int topContributorCount)" + name: "MultivariateLastDetectionOptions(List variables, int topContributorCount)" + nameWithType: "MultivariateLastDetectionOptions.MultivariateLastDetectionOptions(List variables, int topContributorCount)" + summary: "Creates an instance of MultivariateLastDetectionOptions class." + parameters: + - description: "the variables value to set." + name: "variables" + type: "List<>" + - description: "the topContributorCount value to set." + name: "topContributorCount" + type: "" + syntax: "public MultivariateLastDetectionOptions(List variables, int topContributorCount)" + desc: "Creates an instance of MultivariateLastDetectionOptions class." +methods: +- uid: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions.getTopContributorCount()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions.getTopContributorCount()" + name: "getTopContributorCount()" + nameWithType: "MultivariateLastDetectionOptions.getTopContributorCount()" + summary: "Get the topContributorCount property: An optional field, which is used to specify the number of top contributed variables for one anomalous timestamp in the response." + syntax: "public int getTopContributorCount()" + desc: "Get the topContributorCount property: An optional field, which is used to specify the number of top contributed variables for one anomalous timestamp in the response. The default number is 10." + returns: + description: "the topContributorCount value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions.getVariables()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions.getVariables()" + name: "getVariables()" + nameWithType: "MultivariateLastDetectionOptions.getVariables()" + summary: "Get the variables property: This contains the inference data, including the name, timestamps(ISO 8601) and values of variables." + syntax: "public List getVariables()" + desc: "Get the variables property: This contains the inference data, including the name, timestamps(ISO 8601) and values of variables." + returns: + description: "the variables value." + type: "List<>" +type: "class" +desc: "Request of last detection." +metadata: {} +package: "com.azure.ai.anomalydetector.models" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult.yml new file mode 100644 index 000000000000..3332c952af9e --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult.yml @@ -0,0 +1,49 @@ +### YamlMime:JavaType +uid: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult" +fullName: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult" +name: "MultivariateLastDetectionResult" +nameWithType: "MultivariateLastDetectionResult" +summary: "Results of last detection." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **MultivariateLastDetectionResult**" +methods: +- uid: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult.getResults()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult.getResults()" + name: "getResults()" + nameWithType: "MultivariateLastDetectionResult.getResults()" + summary: "Get the results property: Anomaly status and information." + syntax: "public List getResults()" + desc: "Get the results property: Anomaly status and information." + returns: + description: "the results value." + type: "List<>" +- uid: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult.getVariableStates()" + fullName: "com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult.getVariableStates()" + name: "getVariableStates()" + nameWithType: "MultivariateLastDetectionResult.getVariableStates()" + summary: "Get the variableStates property: Variable Status." + syntax: "public List getVariableStates()" + desc: "Get the variableStates property: Variable Status." + returns: + description: "the variableStates value." + type: "List<>" +type: "class" +desc: "Results of last detection." +metadata: {} +package: "com.azure.ai.anomalydetector.models" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TimeGranularity.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TimeGranularity.yml index 40321cfd78c3..d2d6911fde4b 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TimeGranularity.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TimeGranularity.yml @@ -133,4 +133,4 @@ methods: desc: "Defines values for TimeGranularity." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TimeSeriesPoint.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TimeSeriesPoint.yml index 2a8409755f20..49b3fb008957 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TimeSeriesPoint.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TimeSeriesPoint.yml @@ -22,11 +22,17 @@ inheritedClassMethods: - "wait" syntax: "public final class **TimeSeriesPoint**" constructors: -- uid: "com.azure.ai.anomalydetector.models.TimeSeriesPoint.TimeSeriesPoint()" - fullName: "com.azure.ai.anomalydetector.models.TimeSeriesPoint.TimeSeriesPoint()" - name: "TimeSeriesPoint()" - nameWithType: "TimeSeriesPoint.TimeSeriesPoint()" - syntax: "public TimeSeriesPoint()" +- uid: "com.azure.ai.anomalydetector.models.TimeSeriesPoint.TimeSeriesPoint(double)" + fullName: "com.azure.ai.anomalydetector.models.TimeSeriesPoint.TimeSeriesPoint(double value)" + name: "TimeSeriesPoint(double value)" + nameWithType: "TimeSeriesPoint.TimeSeriesPoint(double value)" + summary: "Creates an instance of TimeSeriesPoint class." + parameters: + - description: "the value value to set." + name: "value" + type: "" + syntax: "public TimeSeriesPoint(double value)" + desc: "Creates an instance of TimeSeriesPoint class." methods: - uid: "com.azure.ai.anomalydetector.models.TimeSeriesPoint.getTimestamp()" fullName: "com.azure.ai.anomalydetector.models.TimeSeriesPoint.getTimestamp()" @@ -43,11 +49,11 @@ methods: name: "getValue()" nameWithType: "TimeSeriesPoint.getValue()" summary: "Get the value property: The measurement of that point, should be float." - syntax: "public float getValue()" + syntax: "public double getValue()" desc: "Get the value property: The measurement of that point, should be float." returns: description: "the value value." - type: "" + type: "" - uid: "com.azure.ai.anomalydetector.models.TimeSeriesPoint.setTimestamp(java.time.OffsetDateTime)" fullName: "com.azure.ai.anomalydetector.models.TimeSeriesPoint.setTimestamp(OffsetDateTime timestamp)" name: "setTimestamp(OffsetDateTime timestamp)" @@ -62,22 +68,8 @@ methods: returns: description: "the TimeSeriesPoint object itself." type: "" -- uid: "com.azure.ai.anomalydetector.models.TimeSeriesPoint.setValue(float)" - fullName: "com.azure.ai.anomalydetector.models.TimeSeriesPoint.setValue(float value)" - name: "setValue(float value)" - nameWithType: "TimeSeriesPoint.setValue(float value)" - summary: "Set the value property: The measurement of that point, should be float." - parameters: - - description: "the value value to set." - name: "value" - type: "" - syntax: "public TimeSeriesPoint setValue(float value)" - desc: "Set the value property: The measurement of that point, should be float." - returns: - description: "the TimeSeriesPoint object itself." - type: "" type: "class" desc: "The definition of input timeseries points." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders.yml deleted file mode 100644 index 9b556f8b8601..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders.yml +++ /dev/null @@ -1,59 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders" -fullName: "com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders" -name: "TrainMultivariateModelHeaders" -nameWithType: "TrainMultivariateModelHeaders" -summary: "The TrainMultivariateModelHeaders model." -inheritances: -- "" -inheritedClassMethods: -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **TrainMultivariateModelHeaders**" -constructors: -- uid: "com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders.TrainMultivariateModelHeaders()" - fullName: "com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders.TrainMultivariateModelHeaders()" - name: "TrainMultivariateModelHeaders()" - nameWithType: "TrainMultivariateModelHeaders.TrainMultivariateModelHeaders()" - syntax: "public TrainMultivariateModelHeaders()" -methods: -- uid: "com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders.getLocation()" - fullName: "com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders.getLocation()" - name: "getLocation()" - nameWithType: "TrainMultivariateModelHeaders.getLocation()" - summary: "Get the location property: The Location property." - syntax: "public String getLocation()" - desc: "Get the location property: The Location property." - returns: - description: "the location value." - type: "String" -- uid: "com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders.setLocation(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders.setLocation(String location)" - name: "setLocation(String location)" - nameWithType: "TrainMultivariateModelHeaders.setLocation(String location)" - summary: "Set the location property: The Location property." - parameters: - - description: "the location value to set." - name: "location" - type: "String" - syntax: "public TrainMultivariateModelHeaders setLocation(String location)" - desc: "Set the location property: The Location property." - returns: - description: "the TrainMultivariateModelHeaders object itself." - type: "" -type: "class" -desc: "The TrainMultivariateModelHeaders model." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TrainMultivariateModelResponse.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TrainMultivariateModelResponse.yml deleted file mode 100644 index 9fa299886611..000000000000 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.TrainMultivariateModelResponse.yml +++ /dev/null @@ -1,60 +0,0 @@ -### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.TrainMultivariateModelResponse" -fullName: "com.azure.ai.anomalydetector.models.TrainMultivariateModelResponse" -name: "TrainMultivariateModelResponse" -nameWithType: "TrainMultivariateModelResponse" -summary: "Contains all response data for the trainMultivariateModel operation." -inheritances: -- "" -- "" -inheritedClassMethods: -- classRef: "" - methodsRef: - - "" - - "" - - "" - - "" - - "" -- classRef: "java.lang.Object" - methodsRef: - - "clone" - - "equals" - - "finalize" - - "getClass" - - "hashCode" - - "notify" - - "notifyAll" - - "toString" - - "wait" - - "wait" - - "wait" -syntax: "public final class **TrainMultivariateModelResponse**
extends <,Void>" -constructors: -- uid: "com.azure.ai.anomalydetector.models.TrainMultivariateModelResponse.TrainMultivariateModelResponse(com.azure.core.http.HttpRequest,int,com.azure.core.http.HttpHeaders,java.lang.Void,com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders)" - fullName: "com.azure.ai.anomalydetector.models.TrainMultivariateModelResponse.TrainMultivariateModelResponse(HttpRequest request, int statusCode, HttpHeaders rawHeaders, Void value, TrainMultivariateModelHeaders headers)" - name: "TrainMultivariateModelResponse(HttpRequest request, int statusCode, HttpHeaders rawHeaders, Void value, TrainMultivariateModelHeaders headers)" - nameWithType: "TrainMultivariateModelResponse.TrainMultivariateModelResponse(HttpRequest request, int statusCode, HttpHeaders rawHeaders, Void value, TrainMultivariateModelHeaders headers)" - summary: "Creates an instance of TrainMultivariateModelResponse." - parameters: - - description: "the request which resulted in this TrainMultivariateModelResponse." - name: "request" - type: "" - - description: "the status code of the HTTP response." - name: "statusCode" - type: "" - - description: "the raw headers of the HTTP response." - name: "rawHeaders" - type: "" - - description: "the deserialized value of the HTTP response." - name: "value" - type: "Void" - - description: "the deserialized headers of the HTTP response." - name: "headers" - type: "" - syntax: "public TrainMultivariateModelResponse(HttpRequest request, int statusCode, HttpHeaders rawHeaders, Void value, TrainMultivariateModelHeaders headers)" - desc: "Creates an instance of TrainMultivariateModelResponse." -type: "class" -desc: "Contains all response data for the trainMultivariateModel operation." -metadata: {} -package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ChangePointDetectRequest.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.yml similarity index 53% rename from preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ChangePointDetectRequest.yml rename to preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.yml index 24dbc0452a2b..a77c315e371e 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.ChangePointDetectRequest.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.yml @@ -1,8 +1,8 @@ ### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest" -fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest" -name: "ChangePointDetectRequest" -nameWithType: "ChangePointDetectRequest" +uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions" +fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions" +name: "UnivariateChangePointDetectionOptions" +nameWithType: "UnivariateChangePointDetectionOptions" summary: "The request of change point detection." inheritances: - "" @@ -20,160 +20,141 @@ inheritedClassMethods: - "wait" - "wait" - "wait" -syntax: "public final class **ChangePointDetectRequest**" +syntax: "public final class **UnivariateChangePointDetectionOptions**" constructors: -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.ChangePointDetectRequest()" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.ChangePointDetectRequest()" - name: "ChangePointDetectRequest()" - nameWithType: "ChangePointDetectRequest.ChangePointDetectRequest()" - syntax: "public ChangePointDetectRequest()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.UnivariateChangePointDetectionOptions(java.util.List,com.azure.ai.anomalydetector.models.TimeGranularity)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.UnivariateChangePointDetectionOptions(List series, TimeGranularity granularity)" + name: "UnivariateChangePointDetectionOptions(List series, TimeGranularity granularity)" + nameWithType: "UnivariateChangePointDetectionOptions.UnivariateChangePointDetectionOptions(List series, TimeGranularity granularity)" + summary: "Creates an instance of UnivariateChangePointDetectionOptions class." + parameters: + - description: "the series value to set." + name: "series" + type: "List<>" + - description: "the granularity value to set." + name: "granularity" + type: "" + syntax: "public UnivariateChangePointDetectionOptions(List series, TimeGranularity granularity)" + desc: "Creates an instance of UnivariateChangePointDetectionOptions class." methods: -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getCustomInterval()" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getCustomInterval()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getCustomInterval()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getCustomInterval()" name: "getCustomInterval()" - nameWithType: "ChangePointDetectRequest.getCustomInterval()" + nameWithType: "UnivariateChangePointDetectionOptions.getCustomInterval()" summary: "Get the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as \\{\"granularity\":\"minutely\", \"customInterval\":5\\}." syntax: "public Integer getCustomInterval()" desc: "Get the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as \\{\"granularity\":\"minutely\", \"customInterval\":5\\}." returns: description: "the customInterval value." type: "Integer" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getGranularity()" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getGranularity()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getGranularity()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getGranularity()" name: "getGranularity()" - nameWithType: "ChangePointDetectRequest.getGranularity()" + nameWithType: "UnivariateChangePointDetectionOptions.getGranularity()" summary: "Get the granularity property: Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly." syntax: "public TimeGranularity getGranularity()" desc: "Get the granularity property: Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid." returns: description: "the granularity value." type: "" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getPeriod()" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getPeriod()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getPeriod()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getPeriod()" name: "getPeriod()" - nameWithType: "ChangePointDetectRequest.getPeriod()" + nameWithType: "UnivariateChangePointDetectionOptions.getPeriod()" summary: "Get the period property: Optional argument, periodic value of a time series." syntax: "public Integer getPeriod()" desc: "Get the period property: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically." returns: description: "the period value." type: "Integer" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getSeries()" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getSeries()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getSeries()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getSeries()" name: "getSeries()" - nameWithType: "ChangePointDetectRequest.getSeries()" + nameWithType: "UnivariateChangePointDetectionOptions.getSeries()" summary: "Get the series property: Time series data points." syntax: "public List getSeries()" desc: "Get the series property: Time series data points. Points should be sorted by timestamp in ascending order to match the change point detection result." returns: description: "the series value." type: "List<>" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getStableTrendWindow()" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getStableTrendWindow()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getStableTrendWindow()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getStableTrendWindow()" name: "getStableTrendWindow()" - nameWithType: "ChangePointDetectRequest.getStableTrendWindow()" + nameWithType: "UnivariateChangePointDetectionOptions.getStableTrendWindow()" summary: "Get the stableTrendWindow property: Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection." syntax: "public Integer getStableTrendWindow()" desc: "Get the stableTrendWindow property: Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection." returns: description: "the stableTrendWindow value." type: "Integer" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getThreshold()" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.getThreshold()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getThreshold()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.getThreshold()" name: "getThreshold()" - nameWithType: "ChangePointDetectRequest.getThreshold()" + nameWithType: "UnivariateChangePointDetectionOptions.getThreshold()" summary: "Get the threshold property: Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted." - syntax: "public Float getThreshold()" + syntax: "public Double getThreshold()" desc: "Get the threshold property: Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted." returns: description: "the threshold value." - type: "Float" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setCustomInterval(java.lang.Integer)" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setCustomInterval(Integer customInterval)" + type: "Double" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.setCustomInterval(java.lang.Integer)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.setCustomInterval(Integer customInterval)" name: "setCustomInterval(Integer customInterval)" - nameWithType: "ChangePointDetectRequest.setCustomInterval(Integer customInterval)" + nameWithType: "UnivariateChangePointDetectionOptions.setCustomInterval(Integer customInterval)" summary: "Set the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as \\{\"granularity\":\"minutely\", \"customInterval\":5\\}." parameters: - description: "the customInterval value to set." name: "customInterval" type: "Integer" - syntax: "public ChangePointDetectRequest setCustomInterval(Integer customInterval)" + syntax: "public UnivariateChangePointDetectionOptions setCustomInterval(Integer customInterval)" desc: "Set the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as \\{\"granularity\":\"minutely\", \"customInterval\":5\\}." returns: - description: "the ChangePointDetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setGranularity(com.azure.ai.anomalydetector.models.TimeGranularity)" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setGranularity(TimeGranularity granularity)" - name: "setGranularity(TimeGranularity granularity)" - nameWithType: "ChangePointDetectRequest.setGranularity(TimeGranularity granularity)" - summary: "Set the granularity property: Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly." - parameters: - - description: "the granularity value to set." - name: "granularity" - type: "" - syntax: "public ChangePointDetectRequest setGranularity(TimeGranularity granularity)" - desc: "Set the granularity property: Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid." - returns: - description: "the ChangePointDetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setPeriod(java.lang.Integer)" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setPeriod(Integer period)" + description: "the UnivariateChangePointDetectionOptions object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.setPeriod(java.lang.Integer)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.setPeriod(Integer period)" name: "setPeriod(Integer period)" - nameWithType: "ChangePointDetectRequest.setPeriod(Integer period)" + nameWithType: "UnivariateChangePointDetectionOptions.setPeriod(Integer period)" summary: "Set the period property: Optional argument, periodic value of a time series." parameters: - description: "the period value to set." name: "period" type: "Integer" - syntax: "public ChangePointDetectRequest setPeriod(Integer period)" + syntax: "public UnivariateChangePointDetectionOptions setPeriod(Integer period)" desc: "Set the period property: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically." returns: - description: "the ChangePointDetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setSeries(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setSeries(List series)" - name: "setSeries(List series)" - nameWithType: "ChangePointDetectRequest.setSeries(List series)" - summary: "Set the series property: Time series data points." - parameters: - - description: "the series value to set." - name: "series" - type: "List<>" - syntax: "public ChangePointDetectRequest setSeries(List series)" - desc: "Set the series property: Time series data points. Points should be sorted by timestamp in ascending order to match the change point detection result." - returns: - description: "the ChangePointDetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setStableTrendWindow(java.lang.Integer)" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setStableTrendWindow(Integer stableTrendWindow)" + description: "the UnivariateChangePointDetectionOptions object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.setStableTrendWindow(java.lang.Integer)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.setStableTrendWindow(Integer stableTrendWindow)" name: "setStableTrendWindow(Integer stableTrendWindow)" - nameWithType: "ChangePointDetectRequest.setStableTrendWindow(Integer stableTrendWindow)" + nameWithType: "UnivariateChangePointDetectionOptions.setStableTrendWindow(Integer stableTrendWindow)" summary: "Set the stableTrendWindow property: Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection." parameters: - description: "the stableTrendWindow value to set." name: "stableTrendWindow" type: "Integer" - syntax: "public ChangePointDetectRequest setStableTrendWindow(Integer stableTrendWindow)" + syntax: "public UnivariateChangePointDetectionOptions setStableTrendWindow(Integer stableTrendWindow)" desc: "Set the stableTrendWindow property: Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection." returns: - description: "the ChangePointDetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setThreshold(java.lang.Float)" - fullName: "com.azure.ai.anomalydetector.models.ChangePointDetectRequest.setThreshold(Float threshold)" - name: "setThreshold(Float threshold)" - nameWithType: "ChangePointDetectRequest.setThreshold(Float threshold)" + description: "the UnivariateChangePointDetectionOptions object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.setThreshold(java.lang.Double)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions.setThreshold(Double threshold)" + name: "setThreshold(Double threshold)" + nameWithType: "UnivariateChangePointDetectionOptions.setThreshold(Double threshold)" summary: "Set the threshold property: Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted." parameters: - description: "the threshold value to set." name: "threshold" - type: "Float" - syntax: "public ChangePointDetectRequest setThreshold(Float threshold)" + type: "Double" + syntax: "public UnivariateChangePointDetectionOptions setThreshold(Double threshold)" desc: "Set the threshold property: Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted." returns: - description: "the ChangePointDetectRequest object itself." - type: "" + description: "the UnivariateChangePointDetectionOptions object itself." + type: "" type: "class" desc: "The request of change point detection." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult.yml new file mode 100644 index 000000000000..f21dacc1f20a --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult.yml @@ -0,0 +1,59 @@ +### YamlMime:JavaType +uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult" +fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult" +name: "UnivariateChangePointDetectionResult" +nameWithType: "UnivariateChangePointDetectionResult" +summary: "The response of change point detection." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **UnivariateChangePointDetectionResult**" +methods: +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult.getConfidenceScores()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult.getConfidenceScores()" + name: "getConfidenceScores()" + nameWithType: "UnivariateChangePointDetectionResult.getConfidenceScores()" + summary: "Get the confidenceScores property: the change point confidence of each point." + syntax: "public List getConfidenceScores()" + desc: "Get the confidenceScores property: the change point confidence of each point." + returns: + description: "the confidenceScores value." + type: "List<Double>" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult.getIsChangePoint()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult.getIsChangePoint()" + name: "getIsChangePoint()" + nameWithType: "UnivariateChangePointDetectionResult.getIsChangePoint()" + summary: "Get the isChangePoint property: isChangePoint contains change point properties for each input point." + syntax: "public List getIsChangePoint()" + desc: "Get the isChangePoint property: isChangePoint contains change point properties for each input point. True means an anomaly either negative or positive has been detected. The index of the array is consistent with the input series." + returns: + description: "the isChangePoint value." + type: "List<Boolean>" +- uid: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult.getPeriod()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult.getPeriod()" + name: "getPeriod()" + nameWithType: "UnivariateChangePointDetectionResult.getPeriod()" + summary: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." + syntax: "public Integer getPeriod()" + desc: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." + returns: + description: "the period value." + type: "Integer" +type: "class" +desc: "The response of change point detection." +metadata: {} +package: "com.azure.ai.anomalydetector.models" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectRequest.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.yml similarity index 57% rename from preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectRequest.yml rename to preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.yml index bb22a3773334..77b6017feee7 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.DetectRequest.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.yml @@ -1,8 +1,8 @@ ### YamlMime:JavaType -uid: "com.azure.ai.anomalydetector.models.DetectRequest" -fullName: "com.azure.ai.anomalydetector.models.DetectRequest" -name: "DetectRequest" -nameWithType: "DetectRequest" +uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions" +fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions" +name: "UnivariateDetectionOptions" +nameWithType: "UnivariateDetectionOptions" summary: "The request of entire or last anomaly detection." inheritances: - "" @@ -20,208 +20,200 @@ inheritedClassMethods: - "wait" - "wait" - "wait" -syntax: "public final class **DetectRequest**" +syntax: "public final class **UnivariateDetectionOptions**" constructors: -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.DetectRequest()" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.DetectRequest()" - name: "DetectRequest()" - nameWithType: "DetectRequest.DetectRequest()" - syntax: "public DetectRequest()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.UnivariateDetectionOptions(java.util.List)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.UnivariateDetectionOptions(List series)" + name: "UnivariateDetectionOptions(List series)" + nameWithType: "UnivariateDetectionOptions.UnivariateDetectionOptions(List series)" + summary: "Creates an instance of UnivariateDetectionOptions class." + parameters: + - description: "the series value to set." + name: "series" + type: "List<>" + syntax: "public UnivariateDetectionOptions(List series)" + desc: "Creates an instance of UnivariateDetectionOptions class." methods: -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.getCustomInterval()" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.getCustomInterval()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getCustomInterval()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getCustomInterval()" name: "getCustomInterval()" - nameWithType: "DetectRequest.getCustomInterval()" + nameWithType: "UnivariateDetectionOptions.getCustomInterval()" summary: "Get the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as \\{\"granularity\":\"minutely\", \"customInterval\":5\\}." syntax: "public Integer getCustomInterval()" desc: "Get the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as \\{\"granularity\":\"minutely\", \"customInterval\":5\\}." returns: description: "the customInterval value." type: "Integer" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.getGranularity()" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.getGranularity()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getGranularity()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getGranularity()" name: "getGranularity()" - nameWithType: "DetectRequest.getGranularity()" + nameWithType: "UnivariateDetectionOptions.getGranularity()" summary: "Get the granularity property: Optional argument, can be one of yearly, monthly, weekly, daily, hourly, minutely, secondly, microsecond or none." syntax: "public TimeGranularity getGranularity()" desc: "Get the granularity property: Optional argument, can be one of yearly, monthly, weekly, daily, hourly, minutely, secondly, microsecond or none. If granularity is not present, it will be none by default. If granularity is none, the timestamp property in time series point can be absent." returns: description: "the granularity value." type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.getImputeFixedValue()" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.getImputeFixedValue()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getImputeFixedValue()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getImputeFixedValue()" name: "getImputeFixedValue()" - nameWithType: "DetectRequest.getImputeFixedValue()" + nameWithType: "UnivariateDetectionOptions.getImputeFixedValue()" summary: "Get the imputeFixedValue property: Used to specify the value to fill, it's used when granularity is not \"none\" and imputeMode is \"fixed\"." - syntax: "public Float getImputeFixedValue()" + syntax: "public Double getImputeFixedValue()" desc: "Get the imputeFixedValue property: Used to specify the value to fill, it's used when granularity is not \"none\" and imputeMode is \"fixed\"." returns: description: "the imputeFixedValue value." - type: "Float" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.getImputeMode()" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.getImputeMode()" + type: "Double" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getImputeMode()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getImputeMode()" name: "getImputeMode()" - nameWithType: "DetectRequest.getImputeMode()" + nameWithType: "UnivariateDetectionOptions.getImputeMode()" summary: "Get the imputeMode property: Used to specify how to deal with missing values in the input series, it's used when granularity is not \"none\"." syntax: "public ImputeMode getImputeMode()" desc: "Get the imputeMode property: Used to specify how to deal with missing values in the input series, it's used when granularity is not \"none\"." returns: description: "the imputeMode value." type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.getMaxAnomalyRatio()" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.getMaxAnomalyRatio()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getMaxAnomalyRatio()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getMaxAnomalyRatio()" name: "getMaxAnomalyRatio()" - nameWithType: "DetectRequest.getMaxAnomalyRatio()" + nameWithType: "UnivariateDetectionOptions.getMaxAnomalyRatio()" summary: "Get the maxAnomalyRatio property: Optional argument, advanced model parameter, max anomaly ratio in a time series." - syntax: "public Float getMaxAnomalyRatio()" + syntax: "public Double getMaxAnomalyRatio()" desc: "Get the maxAnomalyRatio property: Optional argument, advanced model parameter, max anomaly ratio in a time series." returns: description: "the maxAnomalyRatio value." - type: "Float" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.getPeriod()" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.getPeriod()" + type: "Double" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getPeriod()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getPeriod()" name: "getPeriod()" - nameWithType: "DetectRequest.getPeriod()" + nameWithType: "UnivariateDetectionOptions.getPeriod()" summary: "Get the period property: Optional argument, periodic value of a time series." syntax: "public Integer getPeriod()" desc: "Get the period property: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically." returns: description: "the period value." type: "Integer" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.getSensitivity()" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.getSensitivity()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getSensitivity()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getSensitivity()" name: "getSensitivity()" - nameWithType: "DetectRequest.getSensitivity()" + nameWithType: "UnivariateDetectionOptions.getSensitivity()" summary: "Get the sensitivity property: Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted." syntax: "public Integer getSensitivity()" desc: "Get the sensitivity property: Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted." returns: description: "the sensitivity value." type: "Integer" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.getSeries()" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.getSeries()" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getSeries()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.getSeries()" name: "getSeries()" - nameWithType: "DetectRequest.getSeries()" + nameWithType: "UnivariateDetectionOptions.getSeries()" summary: "Get the series property: Time series data points." syntax: "public List getSeries()" desc: "Get the series property: Time series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned." returns: description: "the series value." type: "List<>" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.setCustomInterval(java.lang.Integer)" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.setCustomInterval(Integer customInterval)" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setCustomInterval(java.lang.Integer)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setCustomInterval(Integer customInterval)" name: "setCustomInterval(Integer customInterval)" - nameWithType: "DetectRequest.setCustomInterval(Integer customInterval)" + nameWithType: "UnivariateDetectionOptions.setCustomInterval(Integer customInterval)" summary: "Set the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as \\{\"granularity\":\"minutely\", \"customInterval\":5\\}." parameters: - description: "the customInterval value to set." name: "customInterval" type: "Integer" - syntax: "public DetectRequest setCustomInterval(Integer customInterval)" + syntax: "public UnivariateDetectionOptions setCustomInterval(Integer customInterval)" desc: "Set the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as \\{\"granularity\":\"minutely\", \"customInterval\":5\\}." returns: - description: "the DetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.setGranularity(com.azure.ai.anomalydetector.models.TimeGranularity)" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.setGranularity(TimeGranularity granularity)" + description: "the UnivariateDetectionOptions object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setGranularity(com.azure.ai.anomalydetector.models.TimeGranularity)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setGranularity(TimeGranularity granularity)" name: "setGranularity(TimeGranularity granularity)" - nameWithType: "DetectRequest.setGranularity(TimeGranularity granularity)" + nameWithType: "UnivariateDetectionOptions.setGranularity(TimeGranularity granularity)" summary: "Set the granularity property: Optional argument, can be one of yearly, monthly, weekly, daily, hourly, minutely, secondly, microsecond or none." parameters: - description: "the granularity value to set." name: "granularity" type: "" - syntax: "public DetectRequest setGranularity(TimeGranularity granularity)" + syntax: "public UnivariateDetectionOptions setGranularity(TimeGranularity granularity)" desc: "Set the granularity property: Optional argument, can be one of yearly, monthly, weekly, daily, hourly, minutely, secondly, microsecond or none. If granularity is not present, it will be none by default. If granularity is none, the timestamp property in time series point can be absent." returns: - description: "the DetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.setImputeFixedValue(java.lang.Float)" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.setImputeFixedValue(Float imputeFixedValue)" - name: "setImputeFixedValue(Float imputeFixedValue)" - nameWithType: "DetectRequest.setImputeFixedValue(Float imputeFixedValue)" + description: "the UnivariateDetectionOptions object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setImputeFixedValue(java.lang.Double)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setImputeFixedValue(Double imputeFixedValue)" + name: "setImputeFixedValue(Double imputeFixedValue)" + nameWithType: "UnivariateDetectionOptions.setImputeFixedValue(Double imputeFixedValue)" summary: "Set the imputeFixedValue property: Used to specify the value to fill, it's used when granularity is not \"none\" and imputeMode is \"fixed\"." parameters: - description: "the imputeFixedValue value to set." name: "imputeFixedValue" - type: "Float" - syntax: "public DetectRequest setImputeFixedValue(Float imputeFixedValue)" + type: "Double" + syntax: "public UnivariateDetectionOptions setImputeFixedValue(Double imputeFixedValue)" desc: "Set the imputeFixedValue property: Used to specify the value to fill, it's used when granularity is not \"none\" and imputeMode is \"fixed\"." returns: - description: "the DetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.setImputeMode(com.azure.ai.anomalydetector.models.ImputeMode)" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.setImputeMode(ImputeMode imputeMode)" + description: "the UnivariateDetectionOptions object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setImputeMode(com.azure.ai.anomalydetector.models.ImputeMode)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setImputeMode(ImputeMode imputeMode)" name: "setImputeMode(ImputeMode imputeMode)" - nameWithType: "DetectRequest.setImputeMode(ImputeMode imputeMode)" + nameWithType: "UnivariateDetectionOptions.setImputeMode(ImputeMode imputeMode)" summary: "Set the imputeMode property: Used to specify how to deal with missing values in the input series, it's used when granularity is not \"none\"." parameters: - description: "the imputeMode value to set." name: "imputeMode" type: "" - syntax: "public DetectRequest setImputeMode(ImputeMode imputeMode)" + syntax: "public UnivariateDetectionOptions setImputeMode(ImputeMode imputeMode)" desc: "Set the imputeMode property: Used to specify how to deal with missing values in the input series, it's used when granularity is not \"none\"." returns: - description: "the DetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.setMaxAnomalyRatio(java.lang.Float)" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.setMaxAnomalyRatio(Float maxAnomalyRatio)" - name: "setMaxAnomalyRatio(Float maxAnomalyRatio)" - nameWithType: "DetectRequest.setMaxAnomalyRatio(Float maxAnomalyRatio)" + description: "the UnivariateDetectionOptions object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setMaxAnomalyRatio(java.lang.Double)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setMaxAnomalyRatio(Double maxAnomalyRatio)" + name: "setMaxAnomalyRatio(Double maxAnomalyRatio)" + nameWithType: "UnivariateDetectionOptions.setMaxAnomalyRatio(Double maxAnomalyRatio)" summary: "Set the maxAnomalyRatio property: Optional argument, advanced model parameter, max anomaly ratio in a time series." parameters: - description: "the maxAnomalyRatio value to set." name: "maxAnomalyRatio" - type: "Float" - syntax: "public DetectRequest setMaxAnomalyRatio(Float maxAnomalyRatio)" + type: "Double" + syntax: "public UnivariateDetectionOptions setMaxAnomalyRatio(Double maxAnomalyRatio)" desc: "Set the maxAnomalyRatio property: Optional argument, advanced model parameter, max anomaly ratio in a time series." returns: - description: "the DetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.setPeriod(java.lang.Integer)" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.setPeriod(Integer period)" + description: "the UnivariateDetectionOptions object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setPeriod(java.lang.Integer)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setPeriod(Integer period)" name: "setPeriod(Integer period)" - nameWithType: "DetectRequest.setPeriod(Integer period)" + nameWithType: "UnivariateDetectionOptions.setPeriod(Integer period)" summary: "Set the period property: Optional argument, periodic value of a time series." parameters: - description: "the period value to set." name: "period" type: "Integer" - syntax: "public DetectRequest setPeriod(Integer period)" + syntax: "public UnivariateDetectionOptions setPeriod(Integer period)" desc: "Set the period property: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically." returns: - description: "the DetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.setSensitivity(java.lang.Integer)" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.setSensitivity(Integer sensitivity)" + description: "the UnivariateDetectionOptions object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setSensitivity(java.lang.Integer)" + fullName: "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions.setSensitivity(Integer sensitivity)" name: "setSensitivity(Integer sensitivity)" - nameWithType: "DetectRequest.setSensitivity(Integer sensitivity)" + nameWithType: "UnivariateDetectionOptions.setSensitivity(Integer sensitivity)" summary: "Set the sensitivity property: Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted." parameters: - description: "the sensitivity value to set." name: "sensitivity" type: "Integer" - syntax: "public DetectRequest setSensitivity(Integer sensitivity)" + syntax: "public UnivariateDetectionOptions setSensitivity(Integer sensitivity)" desc: "Set the sensitivity property: Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted." returns: - description: "the DetectRequest object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.DetectRequest.setSeries(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.DetectRequest.setSeries(List series)" - name: "setSeries(List series)" - nameWithType: "DetectRequest.setSeries(List series)" - summary: "Set the series property: Time series data points." - parameters: - - description: "the series value to set." - name: "series" - type: "List<>" - syntax: "public DetectRequest setSeries(List series)" - desc: "Set the series property: Time series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned." - returns: - description: "the DetectRequest object itself." - type: "" + description: "the UnivariateDetectionOptions object itself." + type: "" type: "class" desc: "The request of entire or last anomaly detection." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.yml new file mode 100644 index 000000000000..0026facf8b80 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.yml @@ -0,0 +1,109 @@ +### YamlMime:JavaType +uid: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult" +fullName: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult" +name: "UnivariateEntireDetectionResult" +nameWithType: "UnivariateEntireDetectionResult" +summary: "The response of entire anomaly detection." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **UnivariateEntireDetectionResult**" +methods: +- uid: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getExpectedValues()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getExpectedValues()" + name: "getExpectedValues()" + nameWithType: "UnivariateEntireDetectionResult.getExpectedValues()" + summary: "Get the expectedValues property: ExpectedValues contain expected value for each input point." + syntax: "public List getExpectedValues()" + desc: "Get the expectedValues property: ExpectedValues contain expected value for each input point. The index of the array is consistent with the input series." + returns: + description: "the expectedValues value." + type: "List<Double>" +- uid: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getIsAnomaly()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getIsAnomaly()" + name: "getIsAnomaly()" + nameWithType: "UnivariateEntireDetectionResult.getIsAnomaly()" + summary: "Get the isAnomaly property: IsAnomaly contains anomaly properties for each input point." + syntax: "public List getIsAnomaly()" + desc: "Get the isAnomaly property: IsAnomaly contains anomaly properties for each input point. True means an anomaly either negative or positive has been detected. The index of the array is consistent with the input series." + returns: + description: "the isAnomaly value." + type: "List<Boolean>" +- uid: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getIsNegativeAnomaly()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getIsNegativeAnomaly()" + name: "getIsNegativeAnomaly()" + nameWithType: "UnivariateEntireDetectionResult.getIsNegativeAnomaly()" + summary: "Get the isNegativeAnomaly property: IsNegativeAnomaly contains anomaly status in negative direction for each input point." + syntax: "public List getIsNegativeAnomaly()" + desc: "Get the isNegativeAnomaly property: IsNegativeAnomaly contains anomaly status in negative direction for each input point. True means a negative anomaly has been detected. A negative anomaly means the point is detected as an anomaly and its real value is smaller than the expected one. The index of the array is consistent with the input series." + returns: + description: "the isNegativeAnomaly value." + type: "List<Boolean>" +- uid: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getIsPositiveAnomaly()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getIsPositiveAnomaly()" + name: "getIsPositiveAnomaly()" + nameWithType: "UnivariateEntireDetectionResult.getIsPositiveAnomaly()" + summary: "Get the isPositiveAnomaly property: IsPositiveAnomaly contain anomaly status in positive direction for each input point." + syntax: "public List getIsPositiveAnomaly()" + desc: "Get the isPositiveAnomaly property: IsPositiveAnomaly contain anomaly status in positive direction for each input point. True means a positive anomaly has been detected. A positive anomaly means the point is detected as an anomaly and its real value is larger than the expected one. The index of the array is consistent with the input series." + returns: + description: "the isPositiveAnomaly value." + type: "List<Boolean>" +- uid: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getLowerMargins()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getLowerMargins()" + name: "getLowerMargins()" + nameWithType: "UnivariateEntireDetectionResult.getLowerMargins()" + summary: "Get the lowerMargins property: LowerMargins contain lower margin of each input point." + syntax: "public List getLowerMargins()" + desc: "Get the lowerMargins property: LowerMargins contain lower margin of each input point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)\\*lowerMargin. Points between the boundary can be marked as normal ones in client side. The index of the array is consistent with the input series." + returns: + description: "the lowerMargins value." + type: "List<Double>" +- uid: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getPeriod()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getPeriod()" + name: "getPeriod()" + nameWithType: "UnivariateEntireDetectionResult.getPeriod()" + summary: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." + syntax: "public int getPeriod()" + desc: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." + returns: + description: "the period value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getSeverity()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getSeverity()" + name: "getSeverity()" + nameWithType: "UnivariateEntireDetectionResult.getSeverity()" + summary: "Get the severity property: The severity score for each input point." + syntax: "public List getSeverity()" + desc: "Get the severity property: The severity score for each input point. The larger the value is, the more sever the anomaly is. For normal points, the \"severity\" is always 0." + returns: + description: "the severity value." + type: "List<Double>" +- uid: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getUpperMargins()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult.getUpperMargins()" + name: "getUpperMargins()" + nameWithType: "UnivariateEntireDetectionResult.getUpperMargins()" + summary: "Get the upperMargins property: UpperMargins contain upper margin of each input point." + syntax: "public List getUpperMargins()" + desc: "Get the upperMargins property: UpperMargins contain upper margin of each input point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)\\*upperMargin. Anomalies in response can be filtered by upperBoundary and lowerBoundary. By adjusting marginScale value, less significant anomalies can be filtered in client side. The index of the array is consistent with the input series." + returns: + description: "the upperMargins value." + type: "List<Double>" +type: "class" +desc: "The response of entire anomaly detection." +metadata: {} +package: "com.azure.ai.anomalydetector.models" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.yml new file mode 100644 index 000000000000..8acb84676479 --- /dev/null +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.yml @@ -0,0 +1,119 @@ +### YamlMime:JavaType +uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult" +fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult" +name: "UnivariateLastDetectionResult" +nameWithType: "UnivariateLastDetectionResult" +summary: "The response of last anomaly detection." +inheritances: +- "" +inheritedClassMethods: +- classRef: "java.lang.Object" + methodsRef: + - "clone" + - "equals" + - "finalize" + - "getClass" + - "hashCode" + - "notify" + - "notifyAll" + - "toString" + - "wait" + - "wait" + - "wait" +syntax: "public final class **UnivariateLastDetectionResult**" +methods: +- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getExpectedValue()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getExpectedValue()" + name: "getExpectedValue()" + nameWithType: "UnivariateLastDetectionResult.getExpectedValue()" + summary: "Get the expectedValue property: Expected value of the latest point." + syntax: "public double getExpectedValue()" + desc: "Get the expectedValue property: Expected value of the latest point." + returns: + description: "the expectedValue value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getLowerMargin()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getLowerMargin()" + name: "getLowerMargin()" + nameWithType: "UnivariateLastDetectionResult.getLowerMargin()" + summary: "Get the lowerMargin property: Lower margin of the latest point." + syntax: "public double getLowerMargin()" + desc: "Get the lowerMargin property: Lower margin of the latest point. LowerMargin is used to calculate lowerBoundary, which equals to expectedValue - (100 - marginScale)\\*lowerMargin." + returns: + description: "the lowerMargin value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getPeriod()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getPeriod()" + name: "getPeriod()" + nameWithType: "UnivariateLastDetectionResult.getPeriod()" + summary: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." + syntax: "public int getPeriod()" + desc: "Get the period property: Frequency extracted from the series, zero means no recurrent pattern has been found." + returns: + description: "the period value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getSeverity()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getSeverity()" + name: "getSeverity()" + nameWithType: "UnivariateLastDetectionResult.getSeverity()" + summary: "Get the severity property: The severity score for the last input point." + syntax: "public Double getSeverity()" + desc: "Get the severity property: The severity score for the last input point. The larger the value is, the more sever the anomaly is. For normal points, the \"severity\" is always 0." + returns: + description: "the severity value." + type: "Double" +- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getSuggestedWindow()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getSuggestedWindow()" + name: "getSuggestedWindow()" + nameWithType: "UnivariateLastDetectionResult.getSuggestedWindow()" + summary: "Get the suggestedWindow property: Suggested input series points needed for detecting the latest point." + syntax: "public int getSuggestedWindow()" + desc: "Get the suggestedWindow property: Suggested input series points needed for detecting the latest point." + returns: + description: "the suggestedWindow value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getUpperMargin()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.getUpperMargin()" + name: "getUpperMargin()" + nameWithType: "UnivariateLastDetectionResult.getUpperMargin()" + summary: "Get the upperMargin property: Upper margin of the latest point." + syntax: "public double getUpperMargin()" + desc: "Get the upperMargin property: Upper margin of the latest point. UpperMargin is used to calculate upperBoundary, which equals to expectedValue + (100 - marginScale)\\*upperMargin. If the value of latest point is between upperBoundary and lowerBoundary, it should be treated as normal value. By adjusting marginScale value, anomaly status of latest point can be changed." + returns: + description: "the upperMargin value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isAnomaly()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isAnomaly()" + name: "isAnomaly()" + nameWithType: "UnivariateLastDetectionResult.isAnomaly()" + summary: "Get the isAnomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction." + syntax: "public boolean isAnomaly()" + desc: "Get the isAnomaly property: Anomaly status of the latest point, true means the latest point is an anomaly either in negative direction or positive direction." + returns: + description: "the isAnomaly value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isNegativeAnomaly()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isNegativeAnomaly()" + name: "isNegativeAnomaly()" + nameWithType: "UnivariateLastDetectionResult.isNegativeAnomaly()" + summary: "Get the isNegativeAnomaly property: Anomaly status in negative direction of the latest point." + syntax: "public boolean isNegativeAnomaly()" + desc: "Get the isNegativeAnomaly property: Anomaly status in negative direction of the latest point. True means the latest point is an anomaly and its real value is smaller than the expected one." + returns: + description: "the isNegativeAnomaly value." + type: "" +- uid: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isPositiveAnomaly()" + fullName: "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult.isPositiveAnomaly()" + name: "isPositiveAnomaly()" + nameWithType: "UnivariateLastDetectionResult.isPositiveAnomaly()" + summary: "Get the isPositiveAnomaly property: Anomaly status in positive direction of the latest point." + syntax: "public boolean isPositiveAnomaly()" + desc: "Get the isPositiveAnomaly property: Anomaly status in positive direction of the latest point. True means the latest point is an anomaly and its real value is larger than the expected one." + returns: + description: "the isPositiveAnomaly value." + type: "" +type: "class" +desc: "The response of last anomaly detection." +metadata: {} +package: "com.azure.ai.anomalydetector.models" +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.VariableState.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.VariableState.yml index 22e0ad014c36..90f694fe0e92 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.VariableState.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.VariableState.yml @@ -3,7 +3,7 @@ uid: "com.azure.ai.anomalydetector.models.VariableState" fullName: "com.azure.ai.anomalydetector.models.VariableState" name: "VariableState" nameWithType: "VariableState" -summary: "The VariableState model." +summary: "Variable Status." inheritances: - "" inheritedClassMethods: @@ -26,55 +26,57 @@ constructors: fullName: "com.azure.ai.anomalydetector.models.VariableState.VariableState()" name: "VariableState()" nameWithType: "VariableState.VariableState()" + summary: "Creates an instance of VariableState class." syntax: "public VariableState()" + desc: "Creates an instance of VariableState class." methods: - uid: "com.azure.ai.anomalydetector.models.VariableState.getEffectiveCount()" fullName: "com.azure.ai.anomalydetector.models.VariableState.getEffectiveCount()" name: "getEffectiveCount()" nameWithType: "VariableState.getEffectiveCount()" - summary: "Get the effectiveCount property: Number of effective points counted." + summary: "Get the effectiveCount property: Number of effective data points before applying fillNAMethod." syntax: "public Integer getEffectiveCount()" - desc: "Get the effectiveCount property: Number of effective points counted." + desc: "Get the effectiveCount property: Number of effective data points before applying fillNAMethod." returns: description: "the effectiveCount value." type: "Integer" -- uid: "com.azure.ai.anomalydetector.models.VariableState.getEndTime()" - fullName: "com.azure.ai.anomalydetector.models.VariableState.getEndTime()" - name: "getEndTime()" - nameWithType: "VariableState.getEndTime()" - summary: "Get the endTime property: End time of the variable." - syntax: "public OffsetDateTime getEndTime()" - desc: "Get the endTime property: End time of the variable." - returns: - description: "the endTime value." - type: "OffsetDateTime" - uid: "com.azure.ai.anomalydetector.models.VariableState.getFilledNARatio()" fullName: "com.azure.ai.anomalydetector.models.VariableState.getFilledNARatio()" name: "getFilledNARatio()" nameWithType: "VariableState.getFilledNARatio()" - summary: "Get the filledNARatio property: Proportion of NaN values filled of the variable." - syntax: "public Float getFilledNARatio()" - desc: "Get the filledNARatio property: Proportion of NaN values filled of the variable." + summary: "Get the filledNARatio property: Proportion of missing values that need to be filled by fillNAMethod." + syntax: "public Double getFilledNARatio()" + desc: "Get the filledNARatio property: Proportion of missing values that need to be filled by fillNAMethod." returns: description: "the filledNARatio value." - type: "Float" -- uid: "com.azure.ai.anomalydetector.models.VariableState.getStartTime()" - fullName: "com.azure.ai.anomalydetector.models.VariableState.getStartTime()" - name: "getStartTime()" - nameWithType: "VariableState.getStartTime()" - summary: "Get the startTime property: Start time of the variable." - syntax: "public OffsetDateTime getStartTime()" - desc: "Get the startTime property: Start time of the variable." + type: "Double" +- uid: "com.azure.ai.anomalydetector.models.VariableState.getFirstTimestamp()" + fullName: "com.azure.ai.anomalydetector.models.VariableState.getFirstTimestamp()" + name: "getFirstTimestamp()" + nameWithType: "VariableState.getFirstTimestamp()" + summary: "Get the firstTimestamp property: First valid timestamp with value of input data." + syntax: "public OffsetDateTime getFirstTimestamp()" + desc: "Get the firstTimestamp property: First valid timestamp with value of input data." returns: - description: "the startTime value." + description: "the firstTimestamp value." + type: "OffsetDateTime" +- uid: "com.azure.ai.anomalydetector.models.VariableState.getLastTimestamp()" + fullName: "com.azure.ai.anomalydetector.models.VariableState.getLastTimestamp()" + name: "getLastTimestamp()" + nameWithType: "VariableState.getLastTimestamp()" + summary: "Get the lastTimestamp property: Last valid timestamp with value of input data." + syntax: "public OffsetDateTime getLastTimestamp()" + desc: "Get the lastTimestamp property: Last valid timestamp with value of input data." + returns: + description: "the lastTimestamp value." type: "OffsetDateTime" - uid: "com.azure.ai.anomalydetector.models.VariableState.getVariable()" fullName: "com.azure.ai.anomalydetector.models.VariableState.getVariable()" name: "getVariable()" nameWithType: "VariableState.getVariable()" - summary: "Get the variable property: Variable name." + summary: "Get the variable property: Variable name in variable states." syntax: "public String getVariable()" - desc: "Get the variable property: Variable name." + desc: "Get the variable property: Variable name in variable states." returns: description: "the variable value." type: "String" @@ -82,55 +84,55 @@ methods: fullName: "com.azure.ai.anomalydetector.models.VariableState.setEffectiveCount(Integer effectiveCount)" name: "setEffectiveCount(Integer effectiveCount)" nameWithType: "VariableState.setEffectiveCount(Integer effectiveCount)" - summary: "Set the effectiveCount property: Number of effective points counted." + summary: "Set the effectiveCount property: Number of effective data points before applying fillNAMethod." parameters: - description: "the effectiveCount value to set." name: "effectiveCount" type: "Integer" syntax: "public VariableState setEffectiveCount(Integer effectiveCount)" - desc: "Set the effectiveCount property: Number of effective points counted." + desc: "Set the effectiveCount property: Number of effective data points before applying fillNAMethod." returns: description: "the VariableState object itself." type: "" -- uid: "com.azure.ai.anomalydetector.models.VariableState.setEndTime(java.time.OffsetDateTime)" - fullName: "com.azure.ai.anomalydetector.models.VariableState.setEndTime(OffsetDateTime endTime)" - name: "setEndTime(OffsetDateTime endTime)" - nameWithType: "VariableState.setEndTime(OffsetDateTime endTime)" - summary: "Set the endTime property: End time of the variable." - parameters: - - description: "the endTime value to set." - name: "endTime" - type: "OffsetDateTime" - syntax: "public VariableState setEndTime(OffsetDateTime endTime)" - desc: "Set the endTime property: End time of the variable." - returns: - description: "the VariableState object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.VariableState.setFilledNARatio(java.lang.Float)" - fullName: "com.azure.ai.anomalydetector.models.VariableState.setFilledNARatio(Float filledNARatio)" - name: "setFilledNARatio(Float filledNARatio)" - nameWithType: "VariableState.setFilledNARatio(Float filledNARatio)" - summary: "Set the filledNARatio property: Proportion of NaN values filled of the variable." +- uid: "com.azure.ai.anomalydetector.models.VariableState.setFilledNARatio(java.lang.Double)" + fullName: "com.azure.ai.anomalydetector.models.VariableState.setFilledNARatio(Double filledNARatio)" + name: "setFilledNARatio(Double filledNARatio)" + nameWithType: "VariableState.setFilledNARatio(Double filledNARatio)" + summary: "Set the filledNARatio property: Proportion of missing values that need to be filled by fillNAMethod." parameters: - description: "the filledNARatio value to set." name: "filledNARatio" - type: "Float" - syntax: "public VariableState setFilledNARatio(Float filledNARatio)" - desc: "Set the filledNARatio property: Proportion of NaN values filled of the variable." + type: "Double" + syntax: "public VariableState setFilledNARatio(Double filledNARatio)" + desc: "Set the filledNARatio property: Proportion of missing values that need to be filled by fillNAMethod." returns: description: "the VariableState object itself." type: "" -- uid: "com.azure.ai.anomalydetector.models.VariableState.setStartTime(java.time.OffsetDateTime)" - fullName: "com.azure.ai.anomalydetector.models.VariableState.setStartTime(OffsetDateTime startTime)" - name: "setStartTime(OffsetDateTime startTime)" - nameWithType: "VariableState.setStartTime(OffsetDateTime startTime)" - summary: "Set the startTime property: Start time of the variable." +- uid: "com.azure.ai.anomalydetector.models.VariableState.setFirstTimestamp(java.time.OffsetDateTime)" + fullName: "com.azure.ai.anomalydetector.models.VariableState.setFirstTimestamp(OffsetDateTime firstTimestamp)" + name: "setFirstTimestamp(OffsetDateTime firstTimestamp)" + nameWithType: "VariableState.setFirstTimestamp(OffsetDateTime firstTimestamp)" + summary: "Set the firstTimestamp property: First valid timestamp with value of input data." parameters: - - description: "the startTime value to set." - name: "startTime" + - description: "the firstTimestamp value to set." + name: "firstTimestamp" type: "OffsetDateTime" - syntax: "public VariableState setStartTime(OffsetDateTime startTime)" - desc: "Set the startTime property: Start time of the variable." + syntax: "public VariableState setFirstTimestamp(OffsetDateTime firstTimestamp)" + desc: "Set the firstTimestamp property: First valid timestamp with value of input data." + returns: + description: "the VariableState object itself." + type: "" +- uid: "com.azure.ai.anomalydetector.models.VariableState.setLastTimestamp(java.time.OffsetDateTime)" + fullName: "com.azure.ai.anomalydetector.models.VariableState.setLastTimestamp(OffsetDateTime lastTimestamp)" + name: "setLastTimestamp(OffsetDateTime lastTimestamp)" + nameWithType: "VariableState.setLastTimestamp(OffsetDateTime lastTimestamp)" + summary: "Set the lastTimestamp property: Last valid timestamp with value of input data." + parameters: + - description: "the lastTimestamp value to set." + name: "lastTimestamp" + type: "OffsetDateTime" + syntax: "public VariableState setLastTimestamp(OffsetDateTime lastTimestamp)" + desc: "Set the lastTimestamp property: Last valid timestamp with value of input data." returns: description: "the VariableState object itself." type: "" @@ -138,18 +140,18 @@ methods: fullName: "com.azure.ai.anomalydetector.models.VariableState.setVariable(String variable)" name: "setVariable(String variable)" nameWithType: "VariableState.setVariable(String variable)" - summary: "Set the variable property: Variable name." + summary: "Set the variable property: Variable name in variable states." parameters: - description: "the variable value to set." name: "variable" type: "String" syntax: "public VariableState setVariable(String variable)" - desc: "Set the variable property: Variable name." + desc: "Set the variable property: Variable name in variable states." returns: description: "the VariableState object itself." type: "" type: "class" -desc: "The VariableState model." +desc: "Variable Status." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.VariableValues.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.VariableValues.yml index 9fd7b0a9cb3b..2516b052cde9 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.VariableValues.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.VariableValues.yml @@ -3,7 +3,7 @@ uid: "com.azure.ai.anomalydetector.models.VariableValues" fullName: "com.azure.ai.anomalydetector.models.VariableValues" name: "VariableValues" nameWithType: "VariableValues" -summary: "The VariableValues model." +summary: "Variable values." inheritances: - "" inheritedClassMethods: @@ -22,29 +22,31 @@ inheritedClassMethods: - "wait" syntax: "public final class **VariableValues**" constructors: -- uid: "com.azure.ai.anomalydetector.models.VariableValues.VariableValues()" - fullName: "com.azure.ai.anomalydetector.models.VariableValues.VariableValues()" - name: "VariableValues()" - nameWithType: "VariableValues.VariableValues()" - syntax: "public VariableValues()" -methods: -- uid: "com.azure.ai.anomalydetector.models.VariableValues.getName()" - fullName: "com.azure.ai.anomalydetector.models.VariableValues.getName()" - name: "getName()" - nameWithType: "VariableValues.getName()" - summary: "Get the name property: variable name." - syntax: "public String getName()" - desc: "Get the name property: variable name." - returns: - description: "the name value." +- uid: "com.azure.ai.anomalydetector.models.VariableValues.VariableValues(java.lang.String,java.util.List,java.util.List)" + fullName: "com.azure.ai.anomalydetector.models.VariableValues.VariableValues(String variable, List timestamps, List values)" + name: "VariableValues(String variable, List timestamps, List values)" + nameWithType: "VariableValues.VariableValues(String variable, List timestamps, List values)" + summary: "Creates an instance of VariableValues class." + parameters: + - description: "the variable value to set." + name: "variable" type: "String" + - description: "the timestamps value to set." + name: "timestamps" + type: "List<String>" + - description: "the values value to set." + name: "values" + type: "List<Double>" + syntax: "public VariableValues(String variable, List timestamps, List values)" + desc: "Creates an instance of VariableValues class." +methods: - uid: "com.azure.ai.anomalydetector.models.VariableValues.getTimestamps()" fullName: "com.azure.ai.anomalydetector.models.VariableValues.getTimestamps()" name: "getTimestamps()" nameWithType: "VariableValues.getTimestamps()" - summary: "Get the timestamps property: timestamps." + summary: "Get the timestamps property: Timestamps of last detection request." syntax: "public List getTimestamps()" - desc: "Get the timestamps property: timestamps." + desc: "Get the timestamps property: Timestamps of last detection request." returns: description: "the timestamps value." type: "List<String>" @@ -52,56 +54,24 @@ methods: fullName: "com.azure.ai.anomalydetector.models.VariableValues.getValues()" name: "getValues()" nameWithType: "VariableValues.getValues()" - summary: "Get the values property: values." - syntax: "public List getValues()" - desc: "Get the values property: values." + summary: "Get the values property: Values of variables." + syntax: "public List getValues()" + desc: "Get the values property: Values of variables." returns: description: "the values value." - type: "List<Float>" -- uid: "com.azure.ai.anomalydetector.models.VariableValues.setName(java.lang.String)" - fullName: "com.azure.ai.anomalydetector.models.VariableValues.setName(String name)" - name: "setName(String name)" - nameWithType: "VariableValues.setName(String name)" - summary: "Set the name property: variable name." - parameters: - - description: "the name value to set." - name: "name" + type: "List<Double>" +- uid: "com.azure.ai.anomalydetector.models.VariableValues.getVariable()" + fullName: "com.azure.ai.anomalydetector.models.VariableValues.getVariable()" + name: "getVariable()" + nameWithType: "VariableValues.getVariable()" + summary: "Get the variable property: Variable name of last detection request." + syntax: "public String getVariable()" + desc: "Get the variable property: Variable name of last detection request." + returns: + description: "the variable value." type: "String" - syntax: "public VariableValues setName(String name)" - desc: "Set the name property: variable name." - returns: - description: "the VariableValues object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.VariableValues.setTimestamps(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.VariableValues.setTimestamps(List timestamps)" - name: "setTimestamps(List timestamps)" - nameWithType: "VariableValues.setTimestamps(List timestamps)" - summary: "Set the timestamps property: timestamps." - parameters: - - description: "the timestamps value to set." - name: "timestamps" - type: "List<String>" - syntax: "public VariableValues setTimestamps(List timestamps)" - desc: "Set the timestamps property: timestamps." - returns: - description: "the VariableValues object itself." - type: "" -- uid: "com.azure.ai.anomalydetector.models.VariableValues.setValues(java.util.List)" - fullName: "com.azure.ai.anomalydetector.models.VariableValues.setValues(List values)" - name: "setValues(List values)" - nameWithType: "VariableValues.setValues(List values)" - summary: "Set the values property: values." - parameters: - - description: "the values value to set." - name: "values" - type: "List<Float>" - syntax: "public VariableValues setValues(List values)" - desc: "Set the values property: values." - returns: - description: "the VariableValues object itself." - type: "" type: "class" -desc: "The VariableValues model." +desc: "Variable values." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.yml index 1d8f0da4554d..76873937cea7 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.models.yml @@ -2,49 +2,40 @@ uid: "com.azure.ai.anomalydetector.models" fullName: "com.azure.ai.anomalydetector.models" name: "com.azure.ai.anomalydetector.models" -summary: "Package containing the data models for AnomalyDetectorClient." +summary: "Package containing the data models for AnomalyDetector." classes: - "com.azure.ai.anomalydetector.models.AlignPolicy" -- "com.azure.ai.anomalydetector.models.AnomalyDetectorError" -- "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes" -- "com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException" +- "com.azure.ai.anomalydetector.models.AnomalyDetectionModel" - "com.azure.ai.anomalydetector.models.AnomalyInterpretation" - "com.azure.ai.anomalydetector.models.AnomalyState" - "com.azure.ai.anomalydetector.models.AnomalyValue" -- "com.azure.ai.anomalydetector.models.ChangePointDetectRequest" -- "com.azure.ai.anomalydetector.models.ChangePointDetectResponse" - "com.azure.ai.anomalydetector.models.CorrelationChanges" -- "com.azure.ai.anomalydetector.models.DetectAnomalyHeaders" -- "com.azure.ai.anomalydetector.models.DetectAnomalyResponse" -- "com.azure.ai.anomalydetector.models.DetectRequest" -- "com.azure.ai.anomalydetector.models.DetectionRequest" -- "com.azure.ai.anomalydetector.models.DetectionResult" -- "com.azure.ai.anomalydetector.models.DetectionResultSummary" +- "com.azure.ai.anomalydetector.models.DataSchema" - "com.azure.ai.anomalydetector.models.DiagnosticsInfo" -- "com.azure.ai.anomalydetector.models.EntireDetectResponse" - "com.azure.ai.anomalydetector.models.ErrorResponse" -- "com.azure.ai.anomalydetector.models.ErrorResponseException" -- "com.azure.ai.anomalydetector.models.FillNaMethod" +- "com.azure.ai.anomalydetector.models.FillNAMethod" - "com.azure.ai.anomalydetector.models.ImputeMode" -- "com.azure.ai.anomalydetector.models.LastDetectResponse" -- "com.azure.ai.anomalydetector.models.LastDetectionRequest" -- "com.azure.ai.anomalydetector.models.LastDetectionResult" -- "com.azure.ai.anomalydetector.models.Model" - "com.azure.ai.anomalydetector.models.ModelInfo" -- "com.azure.ai.anomalydetector.models.ModelList" -- "com.azure.ai.anomalydetector.models.ModelSnapshot" - "com.azure.ai.anomalydetector.models.ModelState" +- "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions" +- "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary" +- "com.azure.ai.anomalydetector.models.MultivariateDetectionResult" +- "com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions" +- "com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult" - "com.azure.ai.anomalydetector.models.TimeSeriesPoint" -- "com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders" -- "com.azure.ai.anomalydetector.models.TrainMultivariateModelResponse" +- "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions" +- "com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult" +- "com.azure.ai.anomalydetector.models.UnivariateDetectionOptions" +- "com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult" +- "com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult" - "com.azure.ai.anomalydetector.models.VariableState" - "com.azure.ai.anomalydetector.models.VariableValues" enums: - "com.azure.ai.anomalydetector.models.AlignMode" -- "com.azure.ai.anomalydetector.models.DetectionStatus" - "com.azure.ai.anomalydetector.models.ModelStatus" +- "com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus" - "com.azure.ai.anomalydetector.models.TimeGranularity" -desc: "Package containing the data models for AnomalyDetectorClient. The Anomaly Detector API detects anomalies\n automatically in time series data. It supports two kinds of mode, one is for stateless using, another is for stateful\n using. In stateless mode, there are three functionalities. Entire Detect is for detecting the whole series with model\n trained by the time series, Last Detect is detecting last point with model trained by points before. ChangePoint\n Detect is for detecting trend changes in time series. In stateful mode, user can store time series, the stored time\n series will be used for detection anomalies. Under this mode, user can still use the above three functionalities by\n only giving a time range without preparing time series in client side. Besides the above three functionalities,\n stateful model also provide group based detection and labeling service. By leveraging labeling service user can\n provide labels for each detection result, these labels will be used for retuning or regenerating detection models.\n Inconsistency detection is a kind of group based detection, this detection will find inconsistency ones in a set of\n time series. By using anomaly detector service, business customers can discover incidents and establish a logic flow\n for root cause analysis." +desc: "Package containing the data models for AnomalyDetector. The Anomaly Detector API detects anomalies automatically in\n time series data. It supports two kinds of mode, one is for stateless using, another is for stateful using. In\n stateless mode, there are three functionalities. Entire Detect is for detecting the whole series with model trained\n by the time series, Last Detect is detecting last point with model trained by points before. ChangePoint Detect is\n for detecting trend changes in time series. In stateful mode, user can store time series, the stored time series will\n be used for detection anomalies. Under this mode, user can still use the above three functionalities by only giving a\n time range without preparing time series in client side. Besides the above three functionalities, stateful model also\n provide group based detection and labeling service. By leveraging labeling service user can provide labels for each\n detection result, these labels will be used for retuning or regenerating detection models. Inconsistency detection is\n a kind of group based detection, this detection will find inconsistency ones in a set of time series. By using\n anomaly detector service, business customers can discover incidents and establish a logic flow for root cause\n analysis." metadata: {} package: "com.azure.ai.anomalydetector.models" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.yml b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.yml index e749462ed071..573d8ce001ba 100644 --- a/preview/docs-ref-autogen/com.azure.ai.anomalydetector.yml +++ b/preview/docs-ref-autogen/com.azure.ai.anomalydetector.yml @@ -2,12 +2,14 @@ uid: "com.azure.ai.anomalydetector" fullName: "com.azure.ai.anomalydetector" name: "com.azure.ai.anomalydetector" -summary: "Package containing the classes for AnomalyDetectorClient." +summary: "Package containing the classes for AnomalyDetector." classes: - "com.azure.ai.anomalydetector.AnomalyDetectorAsyncClient" - "com.azure.ai.anomalydetector.AnomalyDetectorClient" - "com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder" -desc: "Package containing the classes for AnomalyDetectorClient. The Anomaly Detector API detects anomalies automatically in\n time series data. It supports two kinds of mode, one is for stateless using, another is for stateful using. In\n stateless mode, there are three functionalities. Entire Detect is for detecting the whole series with model trained\n by the time series, Last Detect is detecting last point with model trained by points before. ChangePoint Detect is\n for detecting trend changes in time series. In stateful mode, user can store time series, the stored time series will\n be used for detection anomalies. Under this mode, user can still use the above three functionalities by only giving a\n time range without preparing time series in client side. Besides the above three functionalities, stateful model also\n provide group based detection and labeling service. By leveraging labeling service user can provide labels for each\n detection result, these labels will be used for retuning or regenerating detection models. Inconsistency detection is\n a kind of group based detection, this detection will find inconsistency ones in a set of time series. By using\n anomaly detector service, business customers can discover incidents and establish a logic flow for root cause\n analysis." +enums: +- "com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion" +desc: "Package containing the classes for AnomalyDetector. The Anomaly Detector API detects anomalies automatically in time\n series data. It supports two kinds of mode, one is for stateless using, another is for stateful using. In stateless\n mode, there are three functionalities. Entire Detect is for detecting the whole series with model trained by the time\n series, Last Detect is detecting last point with model trained by points before. ChangePoint Detect is for detecting\n trend changes in time series. In stateful mode, user can store time series, the stored time series will be used for\n detection anomalies. Under this mode, user can still use the above three functionalities by only giving a time range\n without preparing time series in client side. Besides the above three functionalities, stateful model also provide\n group based detection and labeling service. By leveraging labeling service user can provide labels for each detection\n result, these labels will be used for retuning or regenerating detection models. Inconsistency detection is a kind of\n group based detection, this detection will find inconsistency ones in a set of time series. By using anomaly detector\n service, business customers can discover incidents and establish a logic flow for root cause analysis." metadata: {} package: "com.azure.ai.anomalydetector" -artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.4 +artifact: com.azure:azure-ai-anomalydetector:3.0.0-beta.5 diff --git a/preview/docs-ref-autogen/toc.yml b/preview/docs-ref-autogen/toc.yml index 7b9b0fdcb5b1..41be389e603a 100644 --- a/preview/docs-ref-autogen/toc.yml +++ b/preview/docs-ref-autogen/toc.yml @@ -51,6 +51,8 @@ name: AnomalyDetectorClient - uid: com.azure.ai.anomalydetector.AnomalyDetectorClientBuilder name: AnomalyDetectorClientBuilder + - uid: com.azure.ai.anomalydetector.AnomalyDetectorServiceVersion + name: AnomalyDetectorServiceVersion - uid: com.azure.ai.anomalydetector.models name: com.azure.ai.anomalydetector.models items: @@ -58,76 +60,58 @@ name: AlignMode - uid: com.azure.ai.anomalydetector.models.AlignPolicy name: AlignPolicy - - uid: com.azure.ai.anomalydetector.models.AnomalyDetectorError - name: AnomalyDetectorError - - uid: com.azure.ai.anomalydetector.models.AnomalyDetectorErrorCodes - name: AnomalyDetectorErrorCodes - - uid: com.azure.ai.anomalydetector.models.AnomalyDetectorErrorException - name: AnomalyDetectorErrorException + - uid: com.azure.ai.anomalydetector.models.AnomalyDetectionModel + name: AnomalyDetectionModel - uid: com.azure.ai.anomalydetector.models.AnomalyInterpretation name: AnomalyInterpretation - uid: com.azure.ai.anomalydetector.models.AnomalyState name: AnomalyState - uid: com.azure.ai.anomalydetector.models.AnomalyValue name: AnomalyValue - - uid: com.azure.ai.anomalydetector.models.ChangePointDetectRequest - name: ChangePointDetectRequest - - uid: com.azure.ai.anomalydetector.models.ChangePointDetectResponse - name: ChangePointDetectResponse - uid: com.azure.ai.anomalydetector.models.CorrelationChanges name: CorrelationChanges - - uid: com.azure.ai.anomalydetector.models.DetectAnomalyHeaders - name: DetectAnomalyHeaders - - uid: com.azure.ai.anomalydetector.models.DetectAnomalyResponse - name: DetectAnomalyResponse - - uid: com.azure.ai.anomalydetector.models.DetectRequest - name: DetectRequest - - uid: com.azure.ai.anomalydetector.models.DetectionRequest - name: DetectionRequest - - uid: com.azure.ai.anomalydetector.models.DetectionResult - name: DetectionResult - - uid: com.azure.ai.anomalydetector.models.DetectionResultSummary - name: DetectionResultSummary - - uid: com.azure.ai.anomalydetector.models.DetectionStatus - name: DetectionStatus + - uid: com.azure.ai.anomalydetector.models.DataSchema + name: DataSchema - uid: com.azure.ai.anomalydetector.models.DiagnosticsInfo name: DiagnosticsInfo - - uid: com.azure.ai.anomalydetector.models.EntireDetectResponse - name: EntireDetectResponse - uid: com.azure.ai.anomalydetector.models.ErrorResponse name: ErrorResponse - - uid: com.azure.ai.anomalydetector.models.ErrorResponseException - name: ErrorResponseException - - uid: com.azure.ai.anomalydetector.models.FillNaMethod - name: FillNaMethod + - uid: com.azure.ai.anomalydetector.models.FillNAMethod + name: FillNAMethod - uid: com.azure.ai.anomalydetector.models.ImputeMode name: ImputeMode - - uid: com.azure.ai.anomalydetector.models.LastDetectResponse - name: LastDetectResponse - - uid: com.azure.ai.anomalydetector.models.LastDetectionRequest - name: LastDetectionRequest - - uid: com.azure.ai.anomalydetector.models.LastDetectionResult - name: LastDetectionResult - - uid: com.azure.ai.anomalydetector.models.Model - name: Model - uid: com.azure.ai.anomalydetector.models.ModelInfo name: ModelInfo - - uid: com.azure.ai.anomalydetector.models.ModelList - name: ModelList - - uid: com.azure.ai.anomalydetector.models.ModelSnapshot - name: ModelSnapshot - uid: com.azure.ai.anomalydetector.models.ModelState name: ModelState - uid: com.azure.ai.anomalydetector.models.ModelStatus name: ModelStatus + - uid: com.azure.ai.anomalydetector.models.MultivariateBatchDetectionOptions + name: MultivariateBatchDetectionOptions + - uid: com.azure.ai.anomalydetector.models.MultivariateBatchDetectionResultSummary + name: MultivariateBatchDetectionResultSummary + - uid: com.azure.ai.anomalydetector.models.MultivariateBatchDetectionStatus + name: MultivariateBatchDetectionStatus + - uid: com.azure.ai.anomalydetector.models.MultivariateDetectionResult + name: MultivariateDetectionResult + - uid: com.azure.ai.anomalydetector.models.MultivariateLastDetectionOptions + name: MultivariateLastDetectionOptions + - uid: com.azure.ai.anomalydetector.models.MultivariateLastDetectionResult + name: MultivariateLastDetectionResult - uid: com.azure.ai.anomalydetector.models.TimeGranularity name: TimeGranularity - uid: com.azure.ai.anomalydetector.models.TimeSeriesPoint name: TimeSeriesPoint - - uid: com.azure.ai.anomalydetector.models.TrainMultivariateModelHeaders - name: TrainMultivariateModelHeaders - - uid: com.azure.ai.anomalydetector.models.TrainMultivariateModelResponse - name: TrainMultivariateModelResponse + - uid: com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionOptions + name: UnivariateChangePointDetectionOptions + - uid: com.azure.ai.anomalydetector.models.UnivariateChangePointDetectionResult + name: UnivariateChangePointDetectionResult + - uid: com.azure.ai.anomalydetector.models.UnivariateDetectionOptions + name: UnivariateDetectionOptions + - uid: com.azure.ai.anomalydetector.models.UnivariateEntireDetectionResult + name: UnivariateEntireDetectionResult + - uid: com.azure.ai.anomalydetector.models.UnivariateLastDetectionResult + name: UnivariateLastDetectionResult - uid: com.azure.ai.anomalydetector.models.VariableState name: VariableState - uid: com.azure.ai.anomalydetector.models.VariableValues @@ -42711,6 +42695,17 @@ name: UpdateContactProfile - uid: com.microsoft.azure.management.support.v2020_04_01.UpdateSupportTicket name: UpdateSupportTicket +- uid: com.microsoft.durabletask.azurefunctions + name: com.microsoft.durabletask.azurefunctions + items: + - uid: com.microsoft.durabletask.azurefunctions.DurableActivityTrigger + name: DurableActivityTrigger + - uid: com.microsoft.durabletask.azurefunctions.DurableClientContext + name: DurableClientContext + - uid: com.microsoft.durabletask.azurefunctions.DurableClientInput + name: DurableClientInput + - uid: com.microsoft.durabletask.azurefunctions.DurableOrchestrationTrigger + name: DurableOrchestrationTrigger - uid: com.microsoft.azure.sdk.iot.device.DeviceTwin name: com.microsoft.azure.sdk.iot.device.DeviceTwin items: @@ -56321,17 +56316,6 @@ name: ServiceLinkerManager - uid: com.azure.resourcemanager.servicelinker.ServiceLinkerManager.Configurable name: ServiceLinkerManager.Configurable -- uid: com.microsoft.durabletask.azurefunctions - name: com.microsoft.durabletask.azurefunctions - items: - - uid: com.microsoft.durabletask.azurefunctions.DurableActivityTrigger - name: DurableActivityTrigger - - uid: com.microsoft.durabletask.azurefunctions.DurableClientContext - name: DurableClientContext - - uid: com.microsoft.durabletask.azurefunctions.DurableClientInput - name: DurableClientInput - - uid: com.microsoft.durabletask.azurefunctions.DurableOrchestrationTrigger - name: DurableOrchestrationTrigger - uid: com.azure.monitor.ingestion name: com.azure.monitor.ingestion items: diff --git a/preview/docs-ref-mapping/reference-preview.yml b/preview/docs-ref-mapping/reference-preview.yml index 226323f1f3f4..fe8ddbc6c82d 100644 --- a/preview/docs-ref-mapping/reference-preview.yml +++ b/preview/docs-ref-mapping/reference-preview.yml @@ -967,7 +967,7 @@ href: ~/docs-ref-services/preview/functions.md landingPageType: Service items: - - name: Functions - DurableTask + - name: Durable Functions - Java Library children: - com.microsoft.durabletask.azurefunctions landingPageType: Service