Class AttachmentClient

Service client instance for Attachment.

Inheritance

object

ClientBase

RegionalClientBase

AttachmentClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MarketplacepublisherService

Assembly: OCI.DotNetSDK.Marketplacepublisher.dll

Syntax

public class AttachmentClient : RegionalClientBase, IDisposable

Constructors

AttachmentClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public AttachmentClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public AttachmentPaginators Paginators { get; }

Property Value

Type	Description
AttachmentPaginators

Waiters

Declaration

public AttachmentWaiters Waiters { get; }

Property Value

Type	Description
AttachmentWaiters

Methods

CreateAttachment(CreateAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Attachment.

Declaration

public Task<CreateAttachmentResponse> CreateAttachment(CreateAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAttachmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateAttachmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateAttachment API.

DeleteAttachment(DeleteAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Attachment resource by identifier

Declaration

public Task<DeleteAttachmentResponse> DeleteAttachment(DeleteAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAttachmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteAttachmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteAttachment API.

GetAttachment(GetAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a Attachment by identifier

Declaration

public Task<GetAttachmentResponse> GetAttachment(GetAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAttachmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAttachmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAttachment API.

GetAttachmentContent(GetAttachmentContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a Attachment content by identifier

Declaration

public Task<GetAttachmentContentResponse> GetAttachmentContent(GetAttachmentContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAttachmentContentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAttachmentContentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAttachmentContent API.

ListAttachments(ListAttachmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of Attachments. Requires either the BuyerCompartmentId or the SellerCompartmentId params. If neither or both are provided, then the API will return a 400.

Declaration

public Task<ListAttachmentsResponse> ListAttachments(ListAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAttachmentsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAttachmentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAttachments API.

Implements

IDisposable