activity.go

Documentation: github.com/Azure/azure-sdk-for-go/services/preview/automation/mgmt/2021-06-22-preview/automation

     1  package automation
     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  // ActivityClient is the automation Client
    19  type ActivityClient struct {
    20  	BaseClient
    21  }
    22  
    23  // NewActivityClient creates an instance of the ActivityClient client.
    24  func NewActivityClient(subscriptionID string) ActivityClient {
    25  	return NewActivityClientWithBaseURI(DefaultBaseURI, subscriptionID)
    26  }
    27  
    28  // NewActivityClientWithBaseURI creates an instance of the ActivityClient client using a custom endpoint.  Use this
    29  // when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
    30  func NewActivityClientWithBaseURI(baseURI string, subscriptionID string) ActivityClient {
    31  	return ActivityClient{NewWithBaseURI(baseURI, subscriptionID)}
    32  }
    33  
    34  // Get retrieve the activity in the module identified by module name and activity name.
    35  // Parameters:
    36  // resourceGroupName - name of an Azure Resource group.
    37  // automationAccountName - the name of the automation account.
    38  // moduleName - the name of module.
    39  // activityName - the name of activity.
    40  func (client ActivityClient) Get(ctx context.Context, resourceGroupName string, automationAccountName string, moduleName string, activityName string) (result Activity, err error) {
    41  	if tracing.IsEnabled() {
    42  		ctx = tracing.StartSpan(ctx, fqdn+"/ActivityClient.Get")
    43  		defer func() {
    44  			sc := -1
    45  			if result.Response.Response != nil {
    46  				sc = result.Response.Response.StatusCode
    47  			}
    48  			tracing.EndSpan(ctx, sc, err)
    49  		}()
    50  	}
    51  	if err := validation.Validate([]validation.Validation{
    52  		{TargetValue: resourceGroupName,
    53  			Constraints: []validation.Constraint{{Target: "resourceGroupName", Name: validation.MaxLength, Rule: 90, Chain: nil},
    54  				{Target: "resourceGroupName", Name: validation.MinLength, Rule: 1, Chain: nil},
    55  				{Target: "resourceGroupName", Name: validation.Pattern, Rule: `^[-\w\._]+$`, Chain: nil}}}}); err != nil {
    56  		return result, validation.NewError("automation.ActivityClient", "Get", err.Error())
    57  	}
    58  
    59  	req, err := client.GetPreparer(ctx, resourceGroupName, automationAccountName, moduleName, activityName)
    60  	if err != nil {
    61  		err = autorest.NewErrorWithError(err, "automation.ActivityClient", "Get", nil, "Failure preparing request")
    62  		return
    63  	}
    64  
    65  	resp, err := client.GetSender(req)
    66  	if err != nil {
    67  		result.Response = autorest.Response{Response: resp}
    68  		err = autorest.NewErrorWithError(err, "automation.ActivityClient", "Get", resp, "Failure sending request")
    69  		return
    70  	}
    71  
    72  	result, err = client.GetResponder(resp)
    73  	if err != nil {
    74  		err = autorest.NewErrorWithError(err, "automation.ActivityClient", "Get", resp, "Failure responding to request")
    75  		return
    76  	}
    77  
    78  	return
    79  }
    80  
    81  // GetPreparer prepares the Get request.
    82  func (client ActivityClient) GetPreparer(ctx context.Context, resourceGroupName string, automationAccountName string, moduleName string, activityName string) (*http.Request, error) {
    83  	pathParameters := map[string]interface{}{
    84  		"activityName":          autorest.Encode("path", activityName),
    85  		"automationAccountName": autorest.Encode("path", automationAccountName),
    86  		"moduleName":            autorest.Encode("path", moduleName),
    87  		"resourceGroupName":     autorest.Encode("path", resourceGroupName),
    88  		"subscriptionId":        autorest.Encode("path", client.SubscriptionID),
    89  	}
    90  
    91  	const APIVersion = "2020-01-13-preview"
    92  	queryParameters := map[string]interface{}{
    93  		"api-version": APIVersion,
    94  	}
    95  
    96  	preparer := autorest.CreatePreparer(
    97  		autorest.AsGet(),
    98  		autorest.WithBaseURL(client.BaseURI),
    99  		autorest.WithPathParameters("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities/{activityName}", pathParameters),
   100  		autorest.WithQueryParameters(queryParameters))
   101  	return preparer.Prepare((&http.Request{}).WithContext(ctx))
   102  }
   103  
   104  // GetSender sends the Get request. The method will close the
   105  // http.Response Body if it receives an error.
   106  func (client ActivityClient) GetSender(req *http.Request) (*http.Response, error) {
   107  	return client.Send(req, azure.DoRetryWithRegistration(client.Client))
   108  }
   109  
   110  // GetResponder handles the response to the Get request. The method always
   111  // closes the http.Response Body.
   112  func (client ActivityClient) GetResponder(resp *http.Response) (result Activity, err error) {
   113  	err = autorest.Respond(
   114  		resp,
   115  		azure.WithErrorUnlessStatusCode(http.StatusOK),
   116  		autorest.ByUnmarshallingJSON(&result),
   117  		autorest.ByClosing())
   118  	result.Response = autorest.Response{Response: resp}
   119  	return
   120  }
   121  
   122  // ListByModule retrieve a list of activities in the module identified by module name.
   123  // Parameters:
   124  // resourceGroupName - name of an Azure Resource group.
   125  // automationAccountName - the name of the automation account.
   126  // moduleName - the name of module.
   127  func (client ActivityClient) ListByModule(ctx context.Context, resourceGroupName string, automationAccountName string, moduleName string) (result ActivityListResultPage, err error) {
   128  	if tracing.IsEnabled() {
   129  		ctx = tracing.StartSpan(ctx, fqdn+"/ActivityClient.ListByModule")
   130  		defer func() {
   131  			sc := -1
   132  			if result.alr.Response.Response != nil {
   133  				sc = result.alr.Response.Response.StatusCode
   134  			}
   135  			tracing.EndSpan(ctx, sc, err)
   136  		}()
   137  	}
   138  	if err := validation.Validate([]validation.Validation{
   139  		{TargetValue: resourceGroupName,
   140  			Constraints: []validation.Constraint{{Target: "resourceGroupName", Name: validation.MaxLength, Rule: 90, Chain: nil},
   141  				{Target: "resourceGroupName", Name: validation.MinLength, Rule: 1, Chain: nil},
   142  				{Target: "resourceGroupName", Name: validation.Pattern, Rule: `^[-\w\._]+$`, Chain: nil}}}}); err != nil {
   143  		return result, validation.NewError("automation.ActivityClient", "ListByModule", err.Error())
   144  	}
   145  
   146  	result.fn = client.listByModuleNextResults
   147  	req, err := client.ListByModulePreparer(ctx, resourceGroupName, automationAccountName, moduleName)
   148  	if err != nil {
   149  		err = autorest.NewErrorWithError(err, "automation.ActivityClient", "ListByModule", nil, "Failure preparing request")
   150  		return
   151  	}
   152  
   153  	resp, err := client.ListByModuleSender(req)
   154  	if err != nil {
   155  		result.alr.Response = autorest.Response{Response: resp}
   156  		err = autorest.NewErrorWithError(err, "automation.ActivityClient", "ListByModule", resp, "Failure sending request")
   157  		return
   158  	}
   159  
   160  	result.alr, err = client.ListByModuleResponder(resp)
   161  	if err != nil {
   162  		err = autorest.NewErrorWithError(err, "automation.ActivityClient", "ListByModule", resp, "Failure responding to request")
   163  		return
   164  	}
   165  	if result.alr.hasNextLink() && result.alr.IsEmpty() {
   166  		err = result.NextWithContext(ctx)
   167  		return
   168  	}
   169  
   170  	return
   171  }
   172  
   173  // ListByModulePreparer prepares the ListByModule request.
   174  func (client ActivityClient) ListByModulePreparer(ctx context.Context, resourceGroupName string, automationAccountName string, moduleName string) (*http.Request, error) {
   175  	pathParameters := map[string]interface{}{
   176  		"automationAccountName": autorest.Encode("path", automationAccountName),
   177  		"moduleName":            autorest.Encode("path", moduleName),
   178  		"resourceGroupName":     autorest.Encode("path", resourceGroupName),
   179  		"subscriptionId":        autorest.Encode("path", client.SubscriptionID),
   180  	}
   181  
   182  	const APIVersion = "2020-01-13-preview"
   183  	queryParameters := map[string]interface{}{
   184  		"api-version": APIVersion,
   185  	}
   186  
   187  	preparer := autorest.CreatePreparer(
   188  		autorest.AsGet(),
   189  		autorest.WithBaseURL(client.BaseURI),
   190  		autorest.WithPathParameters("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities", pathParameters),
   191  		autorest.WithQueryParameters(queryParameters))
   192  	return preparer.Prepare((&http.Request{}).WithContext(ctx))
   193  }
   194  
   195  // ListByModuleSender sends the ListByModule request. The method will close the
   196  // http.Response Body if it receives an error.
   197  func (client ActivityClient) ListByModuleSender(req *http.Request) (*http.Response, error) {
   198  	return client.Send(req, azure.DoRetryWithRegistration(client.Client))
   199  }
   200  
   201  // ListByModuleResponder handles the response to the ListByModule request. The method always
   202  // closes the http.Response Body.
   203  func (client ActivityClient) ListByModuleResponder(resp *http.Response) (result ActivityListResult, err error) {
   204  	err = autorest.Respond(
   205  		resp,
   206  		azure.WithErrorUnlessStatusCode(http.StatusOK),
   207  		autorest.ByUnmarshallingJSON(&result),
   208  		autorest.ByClosing())
   209  	result.Response = autorest.Response{Response: resp}
   210  	return
   211  }
   212  
   213  // listByModuleNextResults retrieves the next set of results, if any.
   214  func (client ActivityClient) listByModuleNextResults(ctx context.Context, lastResults ActivityListResult) (result ActivityListResult, err error) {
   215  	req, err := lastResults.activityListResultPreparer(ctx)
   216  	if err != nil {
   217  		return result, autorest.NewErrorWithError(err, "automation.ActivityClient", "listByModuleNextResults", nil, "Failure preparing next results request")
   218  	}
   219  	if req == nil {
   220  		return
   221  	}
   222  	resp, err := client.ListByModuleSender(req)
   223  	if err != nil {
   224  		result.Response = autorest.Response{Response: resp}
   225  		return result, autorest.NewErrorWithError(err, "automation.ActivityClient", "listByModuleNextResults", resp, "Failure sending next results request")
   226  	}
   227  	result, err = client.ListByModuleResponder(resp)
   228  	if err != nil {
   229  		err = autorest.NewErrorWithError(err, "automation.ActivityClient", "listByModuleNextResults", resp, "Failure responding to next results request")
   230  	}
   231  	return
   232  }
   233  
   234  // ListByModuleComplete enumerates all values, automatically crossing page boundaries as required.
   235  func (client ActivityClient) ListByModuleComplete(ctx context.Context, resourceGroupName string, automationAccountName string, moduleName string) (result ActivityListResultIterator, err error) {
   236  	if tracing.IsEnabled() {
   237  		ctx = tracing.StartSpan(ctx, fqdn+"/ActivityClient.ListByModule")
   238  		defer func() {
   239  			sc := -1
   240  			if result.Response().Response.Response != nil {
   241  				sc = result.page.Response().Response.Response.StatusCode
   242  			}
   243  			tracing.EndSpan(ctx, sc, err)
   244  		}()
   245  	}
   246  	result.page, err = client.ListByModule(ctx, resourceGroupName, automationAccountName, moduleName)
   247  	return
   248  }
   249
View as plain text