partitionkeyrangeid.go

Documentation: github.com/Azure/azure-sdk-for-go/services/cosmos-db/mgmt/2021-10-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  // PartitionKeyRangeIDClient is the client for the PartitionKeyRangeID methods of the Documentdb service.
    19  type PartitionKeyRangeIDClient struct {
    20  	BaseClient
    21  }
    22  
    23  // NewPartitionKeyRangeIDClient creates an instance of the PartitionKeyRangeIDClient client.
    24  func NewPartitionKeyRangeIDClient(subscriptionID string) PartitionKeyRangeIDClient {
    25  	return NewPartitionKeyRangeIDClientWithBaseURI(DefaultBaseURI, subscriptionID)
    26  }
    27  
    28  // NewPartitionKeyRangeIDClientWithBaseURI creates an instance of the PartitionKeyRangeIDClient 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 NewPartitionKeyRangeIDClientWithBaseURI(baseURI string, subscriptionID string) PartitionKeyRangeIDClient {
    32  	return PartitionKeyRangeIDClient{NewWithBaseURI(baseURI, subscriptionID)}
    33  }
    34  
    35  // ListMetrics retrieves the metrics determined by the given filter for the given partition key range id.
    36  // Parameters:
    37  // resourceGroupName - the name of the resource group. The name is case insensitive.
    38  // accountName - cosmos DB database account name.
    39  // databaseRid - cosmos DB database rid.
    40  // collectionRid - cosmos DB collection rid.
    41  // partitionKeyRangeID - partition Key Range Id for which to get data.
    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 PartitionKeyRangeIDClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (result PartitionMetricListResult, err error) {
    46  	if tracing.IsEnabled() {
    47  		ctx = tracing.StartSpan(ctx, fqdn+"/PartitionKeyRangeIDClient.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  		{TargetValue: accountName,
    63  			Constraints: []validation.Constraint{{Target: "accountName", Name: validation.MaxLength, Rule: 50, Chain: nil},
    64  				{Target: "accountName", Name: validation.MinLength, Rule: 3, Chain: nil},
    65  				{Target: "accountName", Name: validation.Pattern, Rule: `^[a-z0-9]+(-[a-z0-9]+)*`, Chain: nil}}}}); err != nil {
    66  		return result, validation.NewError("documentdb.PartitionKeyRangeIDClient", "ListMetrics", err.Error())
    67  	}
    68  
    69  	req, err := client.ListMetricsPreparer(ctx, resourceGroupName, accountName, databaseRid, collectionRid, partitionKeyRangeID, filter)
    70  	if err != nil {
    71  		err = autorest.NewErrorWithError(err, "documentdb.PartitionKeyRangeIDClient", "ListMetrics", nil, "Failure preparing request")
    72  		return
    73  	}
    74  
    75  	resp, err := client.ListMetricsSender(req)
    76  	if err != nil {
    77  		result.Response = autorest.Response{Response: resp}
    78  		err = autorest.NewErrorWithError(err, "documentdb.PartitionKeyRangeIDClient", "ListMetrics", resp, "Failure sending request")
    79  		return
    80  	}
    81  
    82  	result, err = client.ListMetricsResponder(resp)
    83  	if err != nil {
    84  		err = autorest.NewErrorWithError(err, "documentdb.PartitionKeyRangeIDClient", "ListMetrics", resp, "Failure responding to request")
    85  		return
    86  	}
    87  
    88  	return
    89  }
    90  
    91  // ListMetricsPreparer prepares the ListMetrics request.
    92  func (client PartitionKeyRangeIDClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (*http.Request, error) {
    93  	pathParameters := map[string]interface{}{
    94  		"accountName":         autorest.Encode("path", accountName),
    95  		"collectionRid":       autorest.Encode("path", collectionRid),
    96  		"databaseRid":         autorest.Encode("path", databaseRid),
    97  		"partitionKeyRangeId": autorest.Encode("path", partitionKeyRangeID),
    98  		"resourceGroupName":   autorest.Encode("path", resourceGroupName),
    99  		"subscriptionId":      autorest.Encode("path", client.SubscriptionID),
   100  	}
   101  
   102  	const APIVersion = "2021-10-15"
   103  	queryParameters := map[string]interface{}{
   104  		"$filter":     autorest.Encode("query", filter),
   105  		"api-version": APIVersion,
   106  	}
   107  
   108  	preparer := autorest.CreatePreparer(
   109  		autorest.AsGet(),
   110  		autorest.WithBaseURL(client.BaseURI),
   111  		autorest.WithPathParameters("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics", pathParameters),
   112  		autorest.WithQueryParameters(queryParameters))
   113  	return preparer.Prepare((&http.Request{}).WithContext(ctx))
   114  }
   115  
   116  // ListMetricsSender sends the ListMetrics request. The method will close the
   117  // http.Response Body if it receives an error.
   118  func (client PartitionKeyRangeIDClient) ListMetricsSender(req *http.Request) (*http.Response, error) {
   119  	return client.Send(req, azure.DoRetryWithRegistration(client.Client))
   120  }
   121  
   122  // ListMetricsResponder handles the response to the ListMetrics request. The method always
   123  // closes the http.Response Body.
   124  func (client PartitionKeyRangeIDClient) ListMetricsResponder(resp *http.Response) (result PartitionMetricListResult, err error) {
   125  	err = autorest.Respond(
   126  		resp,
   127  		azure.WithErrorUnlessStatusCode(http.StatusOK),
   128  		autorest.ByUnmarshallingJSON(&result),
   129  		autorest.ByClosing())
   130  	result.Response = autorest.Response{Response: resp}
   131  	return
   132  }
   133
View as plain text