percentiletarget.go

Documentation: github.com/Azure/azure-sdk-for-go/services/cosmos-db/mgmt/2021-03-15/documentdb

     1  package documentdb
     2  
     3  // Copyright (c) Microsoft Corporation. All rights reserved.
     4  // Licensed under the MIT License. See License.txt in the project root for license information.
     5  //
     6  // Code generated by Microsoft (R) AutoRest Code Generator.
     7  // Changes may cause incorrect behavior and will be lost if the code is regenerated.
     8  
     9  import (
    10  	"context"
    11  	"github.com/Azure/go-autorest/autorest"
    12  	"github.com/Azure/go-autorest/autorest/azure"
    13  	"github.com/Azure/go-autorest/autorest/validation"
    14  	"github.com/Azure/go-autorest/tracing"
    15  	"net/http"
    16  )
    17  
    18  // PercentileTargetClient is the azure Cosmos DB Database Service Resource Provider REST API
    19  type PercentileTargetClient struct {
    20  	BaseClient
    21  }
    22  
    23  // NewPercentileTargetClient creates an instance of the PercentileTargetClient client.
    24  func NewPercentileTargetClient(subscriptionID string) PercentileTargetClient {
    25  	return NewPercentileTargetClientWithBaseURI(DefaultBaseURI, subscriptionID)
    26  }
    27  
    28  // NewPercentileTargetClientWithBaseURI creates an instance of the PercentileTargetClient client using a custom
    29  // endpoint.  Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure
    30  // stack).
    31  func NewPercentileTargetClientWithBaseURI(baseURI string, subscriptionID string) PercentileTargetClient {
    32  	return PercentileTargetClient{NewWithBaseURI(baseURI, subscriptionID)}
    33  }
    34  
    35  // ListMetrics retrieves the metrics determined by the given filter for the given account target region. This url is
    36  // only for PBS and Replication Latency data
    37  // Parameters:
    38  // resourceGroupName - the name of the resource group. The name is case insensitive.
    39  // accountName - cosmos DB database account name.
    40  // targetRegion - target region to which data is written. Cosmos DB region, with spaces between words and each
    41  // word capitalized.
    42  // filter - an OData filter expression that describes a subset of metrics to return. The parameters that can be
    43  // filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and
    44  // timeGrain. The supported operator is eq.
    45  func (client PercentileTargetClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, targetRegion string, filter string) (result PercentileMetricListResult, err error) {
    46  	if tracing.IsEnabled() {
    47  		ctx = tracing.StartSpan(ctx, fqdn+"/PercentileTargetClient.ListMetrics")
    48  		defer func() {
    49  			sc := -1
    50  			if result.Response.Response != nil {
    51  				sc = result.Response.Response.StatusCode
    52  			}
    53  			tracing.EndSpan(ctx, sc, err)
    54  		}()
    55  	}
    56  	if err := validation.Validate([]validation.Validation{
    57  		{TargetValue: client.SubscriptionID,
    58  			Constraints: []validation.Constraint{{Target: "client.SubscriptionID", Name: validation.MinLength, Rule: 1, Chain: nil}}},
    59  		{TargetValue: resourceGroupName,
    60  			Constraints: []validation.Constraint{{Target: "resourceGroupName", Name: validation.MaxLength, Rule: 90, Chain: nil},
    61  				{Target: "resourceGroupName", Name: validation.MinLength, Rule: 1, Chain: nil},
    62  				{Target: "resourceGroupName", Name: validation.Pattern, Rule: `^[-\w\._\(\)]+$`, Chain: nil}}},
    63  		{TargetValue: accountName,
    64  			Constraints: []validation.Constraint{{Target: "accountName", Name: validation.MaxLength, Rule: 50, Chain: nil},
    65  				{Target: "accountName", Name: validation.MinLength, Rule: 3, Chain: nil},
    66  				{Target: "accountName", Name: validation.Pattern, Rule: `^[a-z0-9]+(-[a-z0-9]+)*`, Chain: nil}}}}); err != nil {
    67  		return result, validation.NewError("documentdb.PercentileTargetClient", "ListMetrics", err.Error())
    68  	}
    69  
    70  	req, err := client.ListMetricsPreparer(ctx, resourceGroupName, accountName, targetRegion, filter)
    71  	if err != nil {
    72  		err = autorest.NewErrorWithError(err, "documentdb.PercentileTargetClient", "ListMetrics", nil, "Failure preparing request")
    73  		return
    74  	}
    75  
    76  	resp, err := client.ListMetricsSender(req)
    77  	if err != nil {
    78  		result.Response = autorest.Response{Response: resp}
    79  		err = autorest.NewErrorWithError(err, "documentdb.PercentileTargetClient", "ListMetrics", resp, "Failure sending request")
    80  		return
    81  	}
    82  
    83  	result, err = client.ListMetricsResponder(resp)
    84  	if err != nil {
    85  		err = autorest.NewErrorWithError(err, "documentdb.PercentileTargetClient", "ListMetrics", resp, "Failure responding to request")
    86  		return
    87  	}
    88  
    89  	return
    90  }
    91  
    92  // ListMetricsPreparer prepares the ListMetrics request.
    93  func (client PercentileTargetClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, targetRegion string, filter string) (*http.Request, error) {
    94  	pathParameters := map[string]interface{}{
    95  		"accountName":       autorest.Encode("path", accountName),
    96  		"resourceGroupName": autorest.Encode("path", resourceGroupName),
    97  		"subscriptionId":    autorest.Encode("path", client.SubscriptionID),
    98  		"targetRegion":      autorest.Encode("path", targetRegion),
    99  	}
   100  
   101  	const APIVersion = "2021-03-15"
   102  	queryParameters := map[string]interface{}{
   103  		"$filter":     autorest.Encode("query", filter),
   104  		"api-version": APIVersion,
   105  	}
   106  
   107  	preparer := autorest.CreatePreparer(
   108  		autorest.AsGet(),
   109  		autorest.WithBaseURL(client.BaseURI),
   110  		autorest.WithPathParameters("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics", pathParameters),
   111  		autorest.WithQueryParameters(queryParameters))
   112  	return preparer.Prepare((&http.Request{}).WithContext(ctx))
   113  }
   114  
   115  // ListMetricsSender sends the ListMetrics request. The method will close the
   116  // http.Response Body if it receives an error.
   117  func (client PercentileTargetClient) ListMetricsSender(req *http.Request) (*http.Response, error) {
   118  	return client.Send(req, azure.DoRetryWithRegistration(client.Client))
   119  }
   120  
   121  // ListMetricsResponder handles the response to the ListMetrics request. The method always
   122  // closes the http.Response Body.
   123  func (client PercentileTargetClient) ListMetricsResponder(resp *http.Response) (result PercentileMetricListResult, err error) {
   124  	err = autorest.Respond(
   125  		resp,
   126  		azure.WithErrorUnlessStatusCode(http.StatusOK),
   127  		autorest.ByUnmarshallingJSON(&result),
   128  		autorest.ByClosing())
   129  	result.Response = autorest.Response{Response: resp}
   130  	return
   131  }
   132
View as plain text