Class DeploymentClient
Service client instance for Deployment.
Implements
Inherited Members
Namespace: Oci.ApigatewayService
Assembly: OCI.DotNetSDK.Apigateway.dll
Syntax
public class DeploymentClient : RegionalClientBase, IDisposable
Constructors
DeploymentClient(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 DeploymentClient(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 DeploymentPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
DeploymentPaginators |
Waiters
Declaration
public DeploymentWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
DeploymentWaiters |
Methods
ChangeDeploymentCompartment(ChangeDeploymentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Changes the deployment compartment.
Declaration
public Task<ChangeDeploymentCompartmentResponse> ChangeDeploymentCompartment(ChangeDeploymentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeDeploymentCompartmentRequest | 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<ChangeDeploymentCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeDeploymentCompartment API.
CreateDeployment(CreateDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new deployment.
Declaration
public Task<CreateDeploymentResponse> CreateDeployment(CreateDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDeploymentRequest | 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<CreateDeploymentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDeployment API.
DeleteDeployment(DeleteDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the deployment with the given identifier.
Declaration
public Task<DeleteDeploymentResponse> DeleteDeployment(DeleteDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDeploymentRequest | 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<DeleteDeploymentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDeployment API.
GetDeployment(GetDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a deployment by identifier.
Declaration
public Task<GetDeploymentResponse> GetDeployment(GetDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDeploymentRequest | 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<GetDeploymentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDeployment API.
ListDeployments(ListDeploymentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of deployments.
Declaration
public Task<ListDeploymentsResponse> ListDeployments(ListDeploymentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDeploymentsRequest | 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<ListDeploymentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDeployments API.
UpdateDeployment(UpdateDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the deployment with the given identifier.
Declaration
public Task<UpdateDeploymentResponse> UpdateDeployment(UpdateDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDeploymentRequest | 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<UpdateDeploymentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDeployment API.