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