listmanagementimagelists.go

Documentation: github.com/Azure/azure-sdk-for-go/services/cognitiveservices/v1.0/contentmoderator

     1  package contentmoderator
     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/tracing"
    14  	"net/http"
    15  )
    16  
    17  // ListManagementImageListsClient is the you use the API to scan your content as it is generated. Content Moderator
    18  // then processes your content and sends the results along with relevant information either back to your systems or to
    19  // the built-in review tool. You can use this information to take decisions e.g. take it down, send to human judge,
    20  // etc.
    21  //
    22  // When using the API, images need to have a minimum of 128 pixels and a maximum file size of 4MB.
    23  // Text can be at most 1024 characters long.
    24  // If the content passed to the text API or the image API exceeds the size limits, the API will return an error code
    25  // that informs about the issue.
    26  type ListManagementImageListsClient struct {
    27  	BaseClient
    28  }
    29  
    30  // NewListManagementImageListsClient creates an instance of the ListManagementImageListsClient client.
    31  func NewListManagementImageListsClient(endpoint string) ListManagementImageListsClient {
    32  	return ListManagementImageListsClient{New(endpoint)}
    33  }
    34  
    35  // Create creates an image list.
    36  // Parameters:
    37  // contentType - the content type.
    38  // body - schema of the body.
    39  func (client ListManagementImageListsClient) Create(ctx context.Context, contentType string, body Body) (result ImageList, err error) {
    40  	if tracing.IsEnabled() {
    41  		ctx = tracing.StartSpan(ctx, fqdn+"/ListManagementImageListsClient.Create")
    42  		defer func() {
    43  			sc := -1
    44  			if result.Response.Response != nil {
    45  				sc = result.Response.Response.StatusCode
    46  			}
    47  			tracing.EndSpan(ctx, sc, err)
    48  		}()
    49  	}
    50  	req, err := client.CreatePreparer(ctx, contentType, body)
    51  	if err != nil {
    52  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "Create", nil, "Failure preparing request")
    53  		return
    54  	}
    55  
    56  	resp, err := client.CreateSender(req)
    57  	if err != nil {
    58  		result.Response = autorest.Response{Response: resp}
    59  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "Create", resp, "Failure sending request")
    60  		return
    61  	}
    62  
    63  	result, err = client.CreateResponder(resp)
    64  	if err != nil {
    65  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "Create", resp, "Failure responding to request")
    66  		return
    67  	}
    68  
    69  	return
    70  }
    71  
    72  // CreatePreparer prepares the Create request.
    73  func (client ListManagementImageListsClient) CreatePreparer(ctx context.Context, contentType string, body Body) (*http.Request, error) {
    74  	urlParameters := map[string]interface{}{
    75  		"Endpoint": client.Endpoint,
    76  	}
    77  
    78  	preparer := autorest.CreatePreparer(
    79  		autorest.AsContentType("application/json; charset=utf-8"),
    80  		autorest.AsPost(),
    81  		autorest.WithCustomBaseURL("{Endpoint}", urlParameters),
    82  		autorest.WithPath("/contentmoderator/lists/v1.0/imagelists"),
    83  		autorest.WithJSON(body),
    84  		autorest.WithHeader("Content-Type", autorest.String(contentType)))
    85  	return preparer.Prepare((&http.Request{}).WithContext(ctx))
    86  }
    87  
    88  // CreateSender sends the Create request. The method will close the
    89  // http.Response Body if it receives an error.
    90  func (client ListManagementImageListsClient) CreateSender(req *http.Request) (*http.Response, error) {
    91  	return client.Send(req, autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
    92  }
    93  
    94  // CreateResponder handles the response to the Create request. The method always
    95  // closes the http.Response Body.
    96  func (client ListManagementImageListsClient) CreateResponder(resp *http.Response) (result ImageList, err error) {
    97  	err = autorest.Respond(
    98  		resp,
    99  		azure.WithErrorUnlessStatusCode(http.StatusOK),
   100  		autorest.ByUnmarshallingJSON(&result),
   101  		autorest.ByClosing())
   102  	result.Response = autorest.Response{Response: resp}
   103  	return
   104  }
   105  
   106  // Delete deletes image list with the list Id equal to list Id passed.
   107  // Parameters:
   108  // listID - list Id of the image list.
   109  func (client ListManagementImageListsClient) Delete(ctx context.Context, listID string) (result String, err error) {
   110  	if tracing.IsEnabled() {
   111  		ctx = tracing.StartSpan(ctx, fqdn+"/ListManagementImageListsClient.Delete")
   112  		defer func() {
   113  			sc := -1
   114  			if result.Response.Response != nil {
   115  				sc = result.Response.Response.StatusCode
   116  			}
   117  			tracing.EndSpan(ctx, sc, err)
   118  		}()
   119  	}
   120  	req, err := client.DeletePreparer(ctx, listID)
   121  	if err != nil {
   122  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "Delete", nil, "Failure preparing request")
   123  		return
   124  	}
   125  
   126  	resp, err := client.DeleteSender(req)
   127  	if err != nil {
   128  		result.Response = autorest.Response{Response: resp}
   129  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "Delete", resp, "Failure sending request")
   130  		return
   131  	}
   132  
   133  	result, err = client.DeleteResponder(resp)
   134  	if err != nil {
   135  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "Delete", resp, "Failure responding to request")
   136  		return
   137  	}
   138  
   139  	return
   140  }
   141  
   142  // DeletePreparer prepares the Delete request.
   143  func (client ListManagementImageListsClient) DeletePreparer(ctx context.Context, listID string) (*http.Request, error) {
   144  	urlParameters := map[string]interface{}{
   145  		"Endpoint": client.Endpoint,
   146  	}
   147  
   148  	pathParameters := map[string]interface{}{
   149  		"listId": autorest.Encode("path", listID),
   150  	}
   151  
   152  	preparer := autorest.CreatePreparer(
   153  		autorest.AsDelete(),
   154  		autorest.WithCustomBaseURL("{Endpoint}", urlParameters),
   155  		autorest.WithPathParameters("/contentmoderator/lists/v1.0/imagelists/{listId}", pathParameters))
   156  	return preparer.Prepare((&http.Request{}).WithContext(ctx))
   157  }
   158  
   159  // DeleteSender sends the Delete request. The method will close the
   160  // http.Response Body if it receives an error.
   161  func (client ListManagementImageListsClient) DeleteSender(req *http.Request) (*http.Response, error) {
   162  	return client.Send(req, autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
   163  }
   164  
   165  // DeleteResponder handles the response to the Delete request. The method always
   166  // closes the http.Response Body.
   167  func (client ListManagementImageListsClient) DeleteResponder(resp *http.Response) (result String, err error) {
   168  	err = autorest.Respond(
   169  		resp,
   170  		azure.WithErrorUnlessStatusCode(http.StatusOK),
   171  		autorest.ByUnmarshallingJSON(&result.Value),
   172  		autorest.ByClosing())
   173  	result.Response = autorest.Response{Response: resp}
   174  	return
   175  }
   176  
   177  // GetAllImageLists gets all the Image Lists.
   178  func (client ListManagementImageListsClient) GetAllImageLists(ctx context.Context) (result ListImageList, err error) {
   179  	if tracing.IsEnabled() {
   180  		ctx = tracing.StartSpan(ctx, fqdn+"/ListManagementImageListsClient.GetAllImageLists")
   181  		defer func() {
   182  			sc := -1
   183  			if result.Response.Response != nil {
   184  				sc = result.Response.Response.StatusCode
   185  			}
   186  			tracing.EndSpan(ctx, sc, err)
   187  		}()
   188  	}
   189  	req, err := client.GetAllImageListsPreparer(ctx)
   190  	if err != nil {
   191  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "GetAllImageLists", nil, "Failure preparing request")
   192  		return
   193  	}
   194  
   195  	resp, err := client.GetAllImageListsSender(req)
   196  	if err != nil {
   197  		result.Response = autorest.Response{Response: resp}
   198  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "GetAllImageLists", resp, "Failure sending request")
   199  		return
   200  	}
   201  
   202  	result, err = client.GetAllImageListsResponder(resp)
   203  	if err != nil {
   204  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "GetAllImageLists", resp, "Failure responding to request")
   205  		return
   206  	}
   207  
   208  	return
   209  }
   210  
   211  // GetAllImageListsPreparer prepares the GetAllImageLists request.
   212  func (client ListManagementImageListsClient) GetAllImageListsPreparer(ctx context.Context) (*http.Request, error) {
   213  	urlParameters := map[string]interface{}{
   214  		"Endpoint": client.Endpoint,
   215  	}
   216  
   217  	preparer := autorest.CreatePreparer(
   218  		autorest.AsGet(),
   219  		autorest.WithCustomBaseURL("{Endpoint}", urlParameters),
   220  		autorest.WithPath("/contentmoderator/lists/v1.0/imagelists"))
   221  	return preparer.Prepare((&http.Request{}).WithContext(ctx))
   222  }
   223  
   224  // GetAllImageListsSender sends the GetAllImageLists request. The method will close the
   225  // http.Response Body if it receives an error.
   226  func (client ListManagementImageListsClient) GetAllImageListsSender(req *http.Request) (*http.Response, error) {
   227  	return client.Send(req, autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
   228  }
   229  
   230  // GetAllImageListsResponder handles the response to the GetAllImageLists request. The method always
   231  // closes the http.Response Body.
   232  func (client ListManagementImageListsClient) GetAllImageListsResponder(resp *http.Response) (result ListImageList, err error) {
   233  	err = autorest.Respond(
   234  		resp,
   235  		azure.WithErrorUnlessStatusCode(http.StatusOK),
   236  		autorest.ByUnmarshallingJSON(&result.Value),
   237  		autorest.ByClosing())
   238  	result.Response = autorest.Response{Response: resp}
   239  	return
   240  }
   241  
   242  // GetDetails returns the details of the image list with list Id equal to list Id passed.
   243  // Parameters:
   244  // listID - list Id of the image list.
   245  func (client ListManagementImageListsClient) GetDetails(ctx context.Context, listID string) (result ImageList, err error) {
   246  	if tracing.IsEnabled() {
   247  		ctx = tracing.StartSpan(ctx, fqdn+"/ListManagementImageListsClient.GetDetails")
   248  		defer func() {
   249  			sc := -1
   250  			if result.Response.Response != nil {
   251  				sc = result.Response.Response.StatusCode
   252  			}
   253  			tracing.EndSpan(ctx, sc, err)
   254  		}()
   255  	}
   256  	req, err := client.GetDetailsPreparer(ctx, listID)
   257  	if err != nil {
   258  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "GetDetails", nil, "Failure preparing request")
   259  		return
   260  	}
   261  
   262  	resp, err := client.GetDetailsSender(req)
   263  	if err != nil {
   264  		result.Response = autorest.Response{Response: resp}
   265  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "GetDetails", resp, "Failure sending request")
   266  		return
   267  	}
   268  
   269  	result, err = client.GetDetailsResponder(resp)
   270  	if err != nil {
   271  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "GetDetails", resp, "Failure responding to request")
   272  		return
   273  	}
   274  
   275  	return
   276  }
   277  
   278  // GetDetailsPreparer prepares the GetDetails request.
   279  func (client ListManagementImageListsClient) GetDetailsPreparer(ctx context.Context, listID string) (*http.Request, error) {
   280  	urlParameters := map[string]interface{}{
   281  		"Endpoint": client.Endpoint,
   282  	}
   283  
   284  	pathParameters := map[string]interface{}{
   285  		"listId": autorest.Encode("path", listID),
   286  	}
   287  
   288  	preparer := autorest.CreatePreparer(
   289  		autorest.AsGet(),
   290  		autorest.WithCustomBaseURL("{Endpoint}", urlParameters),
   291  		autorest.WithPathParameters("/contentmoderator/lists/v1.0/imagelists/{listId}", pathParameters))
   292  	return preparer.Prepare((&http.Request{}).WithContext(ctx))
   293  }
   294  
   295  // GetDetailsSender sends the GetDetails request. The method will close the
   296  // http.Response Body if it receives an error.
   297  func (client ListManagementImageListsClient) GetDetailsSender(req *http.Request) (*http.Response, error) {
   298  	return client.Send(req, autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
   299  }
   300  
   301  // GetDetailsResponder handles the response to the GetDetails request. The method always
   302  // closes the http.Response Body.
   303  func (client ListManagementImageListsClient) GetDetailsResponder(resp *http.Response) (result ImageList, err error) {
   304  	err = autorest.Respond(
   305  		resp,
   306  		azure.WithErrorUnlessStatusCode(http.StatusOK),
   307  		autorest.ByUnmarshallingJSON(&result),
   308  		autorest.ByClosing())
   309  	result.Response = autorest.Response{Response: resp}
   310  	return
   311  }
   312  
   313  // RefreshIndexMethod refreshes the index of the list with list Id equal to list Id passed.
   314  // Parameters:
   315  // listID - list Id of the image list.
   316  func (client ListManagementImageListsClient) RefreshIndexMethod(ctx context.Context, listID string) (result RefreshIndex, err error) {
   317  	if tracing.IsEnabled() {
   318  		ctx = tracing.StartSpan(ctx, fqdn+"/ListManagementImageListsClient.RefreshIndexMethod")
   319  		defer func() {
   320  			sc := -1
   321  			if result.Response.Response != nil {
   322  				sc = result.Response.Response.StatusCode
   323  			}
   324  			tracing.EndSpan(ctx, sc, err)
   325  		}()
   326  	}
   327  	req, err := client.RefreshIndexMethodPreparer(ctx, listID)
   328  	if err != nil {
   329  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "RefreshIndexMethod", nil, "Failure preparing request")
   330  		return
   331  	}
   332  
   333  	resp, err := client.RefreshIndexMethodSender(req)
   334  	if err != nil {
   335  		result.Response = autorest.Response{Response: resp}
   336  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "RefreshIndexMethod", resp, "Failure sending request")
   337  		return
   338  	}
   339  
   340  	result, err = client.RefreshIndexMethodResponder(resp)
   341  	if err != nil {
   342  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "RefreshIndexMethod", resp, "Failure responding to request")
   343  		return
   344  	}
   345  
   346  	return
   347  }
   348  
   349  // RefreshIndexMethodPreparer prepares the RefreshIndexMethod request.
   350  func (client ListManagementImageListsClient) RefreshIndexMethodPreparer(ctx context.Context, listID string) (*http.Request, error) {
   351  	urlParameters := map[string]interface{}{
   352  		"Endpoint": client.Endpoint,
   353  	}
   354  
   355  	pathParameters := map[string]interface{}{
   356  		"listId": autorest.Encode("path", listID),
   357  	}
   358  
   359  	preparer := autorest.CreatePreparer(
   360  		autorest.AsPost(),
   361  		autorest.WithCustomBaseURL("{Endpoint}", urlParameters),
   362  		autorest.WithPathParameters("/contentmoderator/lists/v1.0/imagelists/{listId}/RefreshIndex", pathParameters))
   363  	return preparer.Prepare((&http.Request{}).WithContext(ctx))
   364  }
   365  
   366  // RefreshIndexMethodSender sends the RefreshIndexMethod request. The method will close the
   367  // http.Response Body if it receives an error.
   368  func (client ListManagementImageListsClient) RefreshIndexMethodSender(req *http.Request) (*http.Response, error) {
   369  	return client.Send(req, autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
   370  }
   371  
   372  // RefreshIndexMethodResponder handles the response to the RefreshIndexMethod request. The method always
   373  // closes the http.Response Body.
   374  func (client ListManagementImageListsClient) RefreshIndexMethodResponder(resp *http.Response) (result RefreshIndex, err error) {
   375  	err = autorest.Respond(
   376  		resp,
   377  		azure.WithErrorUnlessStatusCode(http.StatusOK),
   378  		autorest.ByUnmarshallingJSON(&result),
   379  		autorest.ByClosing())
   380  	result.Response = autorest.Response{Response: resp}
   381  	return
   382  }
   383  
   384  // Update updates an image list with list Id equal to list Id passed.
   385  // Parameters:
   386  // listID - list Id of the image list.
   387  // contentType - the content type.
   388  // body - schema of the body.
   389  func (client ListManagementImageListsClient) Update(ctx context.Context, listID string, contentType string, body Body) (result ImageList, err error) {
   390  	if tracing.IsEnabled() {
   391  		ctx = tracing.StartSpan(ctx, fqdn+"/ListManagementImageListsClient.Update")
   392  		defer func() {
   393  			sc := -1
   394  			if result.Response.Response != nil {
   395  				sc = result.Response.Response.StatusCode
   396  			}
   397  			tracing.EndSpan(ctx, sc, err)
   398  		}()
   399  	}
   400  	req, err := client.UpdatePreparer(ctx, listID, contentType, body)
   401  	if err != nil {
   402  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "Update", nil, "Failure preparing request")
   403  		return
   404  	}
   405  
   406  	resp, err := client.UpdateSender(req)
   407  	if err != nil {
   408  		result.Response = autorest.Response{Response: resp}
   409  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "Update", resp, "Failure sending request")
   410  		return
   411  	}
   412  
   413  	result, err = client.UpdateResponder(resp)
   414  	if err != nil {
   415  		err = autorest.NewErrorWithError(err, "contentmoderator.ListManagementImageListsClient", "Update", resp, "Failure responding to request")
   416  		return
   417  	}
   418  
   419  	return
   420  }
   421  
   422  // UpdatePreparer prepares the Update request.
   423  func (client ListManagementImageListsClient) UpdatePreparer(ctx context.Context, listID string, contentType string, body Body) (*http.Request, error) {
   424  	urlParameters := map[string]interface{}{
   425  		"Endpoint": client.Endpoint,
   426  	}
   427  
   428  	pathParameters := map[string]interface{}{
   429  		"listId": autorest.Encode("path", listID),
   430  	}
   431  
   432  	preparer := autorest.CreatePreparer(
   433  		autorest.AsContentType("application/json; charset=utf-8"),
   434  		autorest.AsPut(),
   435  		autorest.WithCustomBaseURL("{Endpoint}", urlParameters),
   436  		autorest.WithPathParameters("/contentmoderator/lists/v1.0/imagelists/{listId}", pathParameters),
   437  		autorest.WithJSON(body),
   438  		autorest.WithHeader("Content-Type", autorest.String(contentType)))
   439  	return preparer.Prepare((&http.Request{}).WithContext(ctx))
   440  }
   441  
   442  // UpdateSender sends the Update request. The method will close the
   443  // http.Response Body if it receives an error.
   444  func (client ListManagementImageListsClient) UpdateSender(req *http.Request) (*http.Response, error) {
   445  	return client.Send(req, autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
   446  }
   447  
   448  // UpdateResponder handles the response to the Update request. The method always
   449  // closes the http.Response Body.
   450  func (client ListManagementImageListsClient) UpdateResponder(resp *http.Response) (result ImageList, err error) {
   451  	err = autorest.Respond(
   452  		resp,
   453  		azure.WithErrorUnlessStatusCode(http.StatusOK),
   454  		autorest.ByUnmarshallingJSON(&result),
   455  		autorest.ByClosing())
   456  	result.Response = autorest.Response{Response: resp}
   457  	return
   458  }
   459
View as plain text