github.com/twilio/twilio-go@v1.20.1/rest/serverless/v1/docs/ServicesBuildsApi.md (about)

     1  # ServicesBuildsApi
     2  
     3  All URIs are relative to *https://serverless.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateBuild**](ServicesBuildsApi.md#CreateBuild) | **Post** /v1/Services/{ServiceSid}/Builds | 
     8  [**DeleteBuild**](ServicesBuildsApi.md#DeleteBuild) | **Delete** /v1/Services/{ServiceSid}/Builds/{Sid} | 
     9  [**FetchBuild**](ServicesBuildsApi.md#FetchBuild) | **Get** /v1/Services/{ServiceSid}/Builds/{Sid} | 
    10  [**ListBuild**](ServicesBuildsApi.md#ListBuild) | **Get** /v1/Services/{ServiceSid}/Builds | 
    11  
    12  
    13  
    14  ## CreateBuild
    15  
    16  > ServerlessV1Build CreateBuild(ctx, ServiceSidoptional)
    17  
    18  
    19  
    20  Create a new Build resource. At least one function version or asset version is required.
    21  
    22  ### Path Parameters
    23  
    24  
    25  Name | Type | Description
    26  ------------- | ------------- | -------------
    27  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    28  **ServiceSid** | **string** | The SID of the Service to create the Build resource under.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a CreateBuildParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  **AssetVersions** | **[]string** | The list of Asset Version resource SIDs to include in the Build.
    38  **FunctionVersions** | **[]string** | The list of the Function Version resource SIDs to include in the Build.
    39  **Dependencies** | **string** | A list of objects that describe the Dependencies included in the Build. Each object contains the `name` and `version` of the dependency.
    40  **Runtime** | **string** | The Runtime version that will be used to run the Build resource when it is deployed.
    41  
    42  ### Return type
    43  
    44  [**ServerlessV1Build**](ServerlessV1Build.md)
    45  
    46  ### Authorization
    47  
    48  [accountSid_authToken](../README.md#accountSid_authToken)
    49  
    50  ### HTTP request headers
    51  
    52  - **Content-Type**: application/x-www-form-urlencoded
    53  - **Accept**: application/json
    54  
    55  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    56  [[Back to Model list]](../README.md#documentation-for-models)
    57  [[Back to README]](../README.md)
    58  
    59  
    60  ## DeleteBuild
    61  
    62  > DeleteBuild(ctx, ServiceSidSid)
    63  
    64  
    65  
    66  Delete a Build resource.
    67  
    68  ### Path Parameters
    69  
    70  
    71  Name | Type | Description
    72  ------------- | ------------- | -------------
    73  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    74  **ServiceSid** | **string** | The SID of the Service to delete the Build resource from.
    75  **Sid** | **string** | The SID of the Build resource to delete.
    76  
    77  ### Other Parameters
    78  
    79  Other parameters are passed through a pointer to a DeleteBuildParams struct
    80  
    81  
    82  Name | Type | Description
    83  ------------- | ------------- | -------------
    84  
    85  ### Return type
    86  
    87   (empty response body)
    88  
    89  ### Authorization
    90  
    91  [accountSid_authToken](../README.md#accountSid_authToken)
    92  
    93  ### HTTP request headers
    94  
    95  - **Content-Type**: Not defined
    96  - **Accept**: Not defined
    97  
    98  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    99  [[Back to Model list]](../README.md#documentation-for-models)
   100  [[Back to README]](../README.md)
   101  
   102  
   103  ## FetchBuild
   104  
   105  > ServerlessV1Build FetchBuild(ctx, ServiceSidSid)
   106  
   107  
   108  
   109  Retrieve a specific Build resource.
   110  
   111  ### Path Parameters
   112  
   113  
   114  Name | Type | Description
   115  ------------- | ------------- | -------------
   116  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   117  **ServiceSid** | **string** | The SID of the Service to fetch the Build resource from.
   118  **Sid** | **string** | The SID of the Build resource to fetch.
   119  
   120  ### Other Parameters
   121  
   122  Other parameters are passed through a pointer to a FetchBuildParams struct
   123  
   124  
   125  Name | Type | Description
   126  ------------- | ------------- | -------------
   127  
   128  ### Return type
   129  
   130  [**ServerlessV1Build**](ServerlessV1Build.md)
   131  
   132  ### Authorization
   133  
   134  [accountSid_authToken](../README.md#accountSid_authToken)
   135  
   136  ### HTTP request headers
   137  
   138  - **Content-Type**: Not defined
   139  - **Accept**: application/json
   140  
   141  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   142  [[Back to Model list]](../README.md#documentation-for-models)
   143  [[Back to README]](../README.md)
   144  
   145  
   146  ## ListBuild
   147  
   148  > []ServerlessV1Build ListBuild(ctx, ServiceSidoptional)
   149  
   150  
   151  
   152  Retrieve a list of all Builds.
   153  
   154  ### Path Parameters
   155  
   156  
   157  Name | Type | Description
   158  ------------- | ------------- | -------------
   159  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   160  **ServiceSid** | **string** | The SID of the Service to read the Build resources from.
   161  
   162  ### Other Parameters
   163  
   164  Other parameters are passed through a pointer to a ListBuildParams struct
   165  
   166  
   167  Name | Type | Description
   168  ------------- | ------------- | -------------
   169  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   170  **Limit** | **int** | Max number of records to return.
   171  
   172  ### Return type
   173  
   174  [**[]ServerlessV1Build**](ServerlessV1Build.md)
   175  
   176  ### Authorization
   177  
   178  [accountSid_authToken](../README.md#accountSid_authToken)
   179  
   180  ### HTTP request headers
   181  
   182  - **Content-Type**: Not defined
   183  - **Accept**: application/json
   184  
   185  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   186  [[Back to Model list]](../README.md#documentation-for-models)
   187  [[Back to README]](../README.md)
   188