Package com.azure.analytics.onlineexperimentation

Class OnlineExperimentationClient

java.lang.Object
com.azure.analytics.onlineexperimentation.OnlineExperimentationClient
public final class OnlineExperimentationClient extends Object
Initializes a new instance of the synchronous OnlineExperimentationClient type.

  • Method Details

    • getMetricWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getMetricWithResponse(String experimentMetricId, com.azure.core.http.rest.RequestOptions requestOptions)
      Fetches an experiment metric by ID.

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-MatchStringNoThe request should only proceed if an entity matches this string.
      If-None-MatchStringNoThe request should only proceed if no entity matches this string.
      If-Unmodified-SinceOffsetDateTimeNoThe request should only proceed if the entity was not modified after this time.
      If-Modified-SinceOffsetDateTimeNoThe request should only proceed if the entity was modified after this time.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Required)
     lifecycle: String(Active/Inactive) (Optional, Required on create)
     displayName: String (Optional, Required on create)
     description: String (Optional, Required on create)
     categories (Optional, Required on create): [
         String (Optional, Required on create)
     ]
     desiredDirection: String(Increase/Decrease/Neutral) (Optional, Required on create)
     definition (Optional, Required on create): {
         type: String(EventCount/UserCount/EventRate/UserRate/Sum/Average/Percentile) (Required)
     }
     eTag: String (Required)
     lastModifiedAt: OffsetDateTime (Required)
 }
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      defines experiment metric metadata and computation details along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • createOrUpdateMetricWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createOrUpdateMetricWithResponse(String experimentMetricId, com.azure.core.util.BinaryData resource, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates or updates an experiment metric.

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-MatchStringNoThe request should only proceed if an entity matches this string.
      If-None-MatchStringNoThe request should only proceed if no entity matches this string.
      If-Unmodified-SinceOffsetDateTimeNoThe request should only proceed if the entity was not modified after this time.
      If-Modified-SinceOffsetDateTimeNoThe request should only proceed if the entity was modified after this time.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)

      Request Body Schema

       
 {
     id: String (Required)
     lifecycle: String(Active/Inactive) (Optional, Required on create)
     displayName: String (Optional, Required on create)
     description: String (Optional, Required on create)
     categories (Optional, Required on create): [
         String (Optional, Required on create)
     ]
     desiredDirection: String(Increase/Decrease/Neutral) (Optional, Required on create)
     definition (Optional, Required on create): {
         type: String(EventCount/UserCount/EventRate/UserRate/Sum/Average/Percentile) (Required)
     }
     eTag: String (Required)
     lastModifiedAt: OffsetDateTime (Required)
 }

      Response Body Schema

       
 {
     id: String (Required)
     lifecycle: String(Active/Inactive) (Optional, Required on create)
     displayName: String (Optional, Required on create)
     description: String (Optional, Required on create)
     categories (Optional, Required on create): [
         String (Optional, Required on create)
     ]
     desiredDirection: String(Increase/Decrease/Neutral) (Optional, Required on create)
     definition (Optional, Required on create): {
         type: String(EventCount/UserCount/EventRate/UserRate/Sum/Average/Percentile) (Required)
     }
     eTag: String (Required)
     lastModifiedAt: OffsetDateTime (Required)
 }
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      resource - The resource instance.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      defines experiment metric metadata and computation details along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • validateMetricWithResponse

      public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> validateMetricWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)
      Validates an experiment metric definition.

      Request Body Schema

       
 {
     id: String (Required)
     lifecycle: String(Active/Inactive) (Optional, Required on create)
     displayName: String (Optional, Required on create)
     description: String (Optional, Required on create)
     categories (Optional, Required on create): [
         String (Optional, Required on create)
     ]
     desiredDirection: String(Increase/Decrease/Neutral) (Optional, Required on create)
     definition (Optional, Required on create): {
         type: String(EventCount/UserCount/EventRate/UserRate/Sum/Average/Percentile) (Required)
     }
     eTag: String (Required)
     lastModifiedAt: OffsetDateTime (Required)
 }

      Response Body Schema

       
 {
     isValid: boolean (Required)
     diagnostics (Required): [
          (Required){
             message: String (Required)
             code: String(FailedSchemaValidation/InvalidEventCondition/UnsupportedEventCondition/InvalidExperimentMetricDefinition) (Required)
         }
     ]
 }
      Parameters:
      body - Experiment metric input to validate.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the result of validating an experiment metric along with Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • deleteMetricWithResponse

      public com.azure.core.http.rest.Response<Void> deleteMetricWithResponse(String experimentMetricId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deletes an experiment metric.

      Header Parameters

      Header Parameters
      NameTypeRequiredDescription
      If-MatchStringNoThe request should only proceed if an entity matches this string.
      If-None-MatchStringNoThe request should only proceed if no entity matches this string.
      If-Unmodified-SinceOffsetDateTimeNoThe request should only proceed if the entity was not modified after this time.
      If-Modified-SinceOffsetDateTimeNoThe request should only proceed if the entity was modified after this time.
      You can add these to a request with RequestOptions.addHeader(java.lang.String, java.lang.String)
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Response.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • listMetrics

      public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listMetrics(com.azure.core.http.rest.RequestOptions requestOptions)
      Lists experiment metrics.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      topIntegerNoThe number of result items to return.
      skipIntegerNoThe number of result items to skip.
      maxpagesizeIntegerNoThe maximum number of result items per page.
      You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

      Response Body Schema

       
 {
     id: String (Required)
     lifecycle: String(Active/Inactive) (Optional, Required on create)
     displayName: String (Optional, Required on create)
     description: String (Optional, Required on create)
     categories (Optional, Required on create): [
         String (Optional, Required on create)
     ]
     desiredDirection: String(Increase/Decrease/Neutral) (Optional, Required on create)
     definition (Optional, Required on create): {
         type: String(EventCount/UserCount/EventRate/UserRate/Sum/Average/Percentile) (Required)
     }
     eTag: String (Required)
     lastModifiedAt: OffsetDateTime (Required)
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      paged collection of ExperimentMetric items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getMetric

      public ExperimentMetric getMetric(String experimentMetricId, com.azure.core.http.RequestConditions requestConditions)
      Fetches an experiment metric by ID.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      defines experiment metric metadata and computation details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getMetric

      public ExperimentMetric getMetric(String experimentMetricId)
      Fetches an experiment metric by ID.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      Returns:
      defines experiment metric metadata and computation details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdateMetric

      public ExperimentMetric createOrUpdateMetric(String experimentMetricId, ExperimentMetric resource, com.azure.core.http.RequestConditions requestConditions)
      Creates or updates an experiment metric.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      resource - The resource instance.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Returns:
      defines experiment metric metadata and computation details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdateMetric

      public ExperimentMetric createOrUpdateMetric(String experimentMetricId, ExperimentMetric resource)
      Creates or updates an experiment metric.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      resource - The resource instance.
      Returns:
      defines experiment metric metadata and computation details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • validateMetric

      public ExperimentMetricValidationResult validateMetric(ExperimentMetric body)
      Validates an experiment metric definition.
      Parameters:
      body - Experiment metric input to validate.
      Returns:
      the result of validating an experiment metric.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteMetric

      public void deleteMetric(String experimentMetricId, com.azure.core.http.RequestConditions requestConditions)
      Deletes an experiment metric.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      requestConditions - Specifies HTTP options for conditional requests based on modification time.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteMetric

      public void deleteMetric(String experimentMetricId)
      Deletes an experiment metric.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listMetrics

      public com.azure.core.http.rest.PagedIterable<ExperimentMetric> listMetrics(Integer top, Integer skip)
      Lists experiment metrics.
      Parameters:
      top - The number of result items to return.
      skip - The number of result items to skip.
      Returns:
      paged collection of ExperimentMetric items as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listMetrics

      public com.azure.core.http.rest.PagedIterable<ExperimentMetric> listMetrics()
      Lists experiment metrics.
      Returns:
      paged collection of ExperimentMetric items as paginated response with PagedIterable.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdateMetricWithResponse

      public com.azure.core.http.rest.Response<ExperimentMetric> createOrUpdateMetricWithResponse(String experimentMetricId, ExperimentMetric resource, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates or updates an experiment metric with response and conditional headers from RequestConditions.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      resource - The resource instance.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      defines experiment metric metadata and computation details along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createMetric

      public ExperimentMetric createMetric(String experimentMetricId, ExperimentMetric resource)
      Creates or updates an experiment metric.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      resource - The resource instance.
      Returns:
      defines experiment metric metadata and computation details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createMetricWithResponse

      public com.azure.core.http.rest.Response<ExperimentMetric> createMetricWithResponse(String experimentMetricId, ExperimentMetric resource, com.azure.core.http.rest.RequestOptions requestOptions)
      Creates an experiment metric with a response.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      resource - The resource instance.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      defines experiment metric metadata and computation details along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateMetric

      public ExperimentMetric updateMetric(String experimentMetricId, ExperimentMetric resource, String ifMatch)
      Creates or updates an experiment metric.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      resource - The resource instance.
      ifMatch - The ETag value to match for the request.
      Returns:
      defines experiment metric metadata and computation details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateMetric

      public ExperimentMetric updateMetric(String experimentMetricId, ExperimentMetric resource)
      Creates or updates an experiment metric.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      resource - The resource instance.
      Returns:
      defines experiment metric metadata and computation details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateMetricWithResponse

      public com.azure.core.http.rest.Response<ExperimentMetric> updateMetricWithResponse(String experimentMetricId, ExperimentMetric resource, com.azure.core.http.rest.RequestOptions requestOptions)
      Updates an experiment metric with a response.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      resource - The resource instance.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      defines experiment metric metadata and computation details along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • activateMetric

      public ExperimentMetric activateMetric(String experimentMetricId, String ifMatch)
      Updates the experiment metric lifecycle to LifecycleStage.ACTIVE.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      ifMatch - The ETag value to match for the request.
      Returns:
      defines experiment metric metadata and computation details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • activateMetric

      public ExperimentMetric activateMetric(String experimentMetricId)
      Updates the experiment metric lifecycle to LifecycleStage.ACTIVE.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      Returns:
      defines experiment metric metadata and computation details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • activateMetricWithResponse

      public com.azure.core.http.rest.Response<ExperimentMetric> activateMetricWithResponse(String experimentMetricId, com.azure.core.http.rest.RequestOptions requestOptions)
      Activates an experiment metric with a response.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      defines experiment metric metadata and computation details along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deactivateMetric

      public ExperimentMetric deactivateMetric(String experimentMetricId, String ifMatch)
      Updates the experiment metric lifecycle to LifecycleStage.INACTIVE.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      ifMatch - The ETag value to match for the request.
      Returns:
      defines experiment metric metadata and computation details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deactivateMetric

      public ExperimentMetric deactivateMetric(String experimentMetricId)
      Updates the experiment metric lifecycle to LifecycleStage.INACTIVE. o
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      Returns:
      defines experiment metric metadata and computation details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deactivateMetricWithResponse

      public com.azure.core.http.rest.Response<ExperimentMetric> deactivateMetricWithResponse(String experimentMetricId, com.azure.core.http.rest.RequestOptions requestOptions)
      Deactivates an experiment metric with a response.
      Parameters:
      experimentMetricId - Identifier for this experiment metric. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      defines experiment metric metadata and computation details along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.