Class S3Api
Inheritance
System.Object
S3Api
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Bitmovin.Api.Sdk.Encoding.Outputs.S3
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class S3ApiConstructors
S3Api(IBitmovinApiClientFactory)
Declaration
public S3Api(IBitmovinApiClientFactory apiClientFactory)Parameters
| Type | Name | Description |
|---|---|---|
| IBitmovinApiClientFactory | apiClientFactory |
Properties
Builder
Fluent builder for creating an instance of S3Api
Declaration
public static BitmovinApiBuilder<S3Api> Builder { get; }Property Value
| Type | Description |
|---|---|
| BitmovinApiBuilder<S3Api> |
Customdata
Declaration
public CustomdataApi Customdata { get; }Property Value
| Type | Description |
|---|---|
| CustomdataApi |
Methods
CreateAsync(S3Output)
Create S3 Output
Declaration
public Task<S3Output> CreateAsync(S3Output s3Output)Parameters
| Type | Name | Description |
|---|---|---|
| S3Output | s3Output | The S3 output to be created The following permissions are required for S3 output: * s3:PutObject * s3:PutObjectAcl * s3:ListBucket * s3:GetBucketLocation |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<S3Output> |
DeleteAsync(String)
Delete S3 Output
Declaration
public Task<S3Output> DeleteAsync(string outputId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | outputId | Id of the output (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<S3Output> |
GetAsync(String)
S3 Output Details
Declaration
public Task<S3Output> GetAsync(string outputId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | outputId | Id of the input (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<S3Output> |
ListAsync(Func<S3Api.ListQueryParams, S3Api.ListQueryParams>[])
List S3 Outputs
Declaration
public Task<PaginationResponse<S3Output>> ListAsync(params Func<S3Api.ListQueryParams, S3Api.ListQueryParams>[] queryParams)Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<S3Api.ListQueryParams, S3Api.ListQueryParams>[] | queryParams | The query parameters for sorting, filtering and paging options (optional) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PaginationResponse<S3Output>> |