Class OcbAgentSvcClient
Service client instance for OcbAgentSvc.
Implements
Inherited Members
Namespace: Oci.CloudbridgeService
Assembly: OCI.DotNetSDK.Cloudbridge.dll
Syntax
public class OcbAgentSvcClient : RegionalClientBase, IDisposable
Constructors
OcbAgentSvcClient(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 OcbAgentSvcClient(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 OcbAgentSvcPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
OcbAgentSvcPaginators |
Waiters
Declaration
public OcbAgentSvcWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
OcbAgentSvcWaiters |
Methods
AddAgentDependency(AddAgentDependencyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add a dependency to the environment. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<AddAgentDependencyResponse> AddAgentDependency(AddAgentDependencyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddAgentDependencyRequest | 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<AddAgentDependencyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddAgentDependency API.
ChangeAgentCompartment(ChangeAgentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves an Agent resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeAgentCompartmentResponse> ChangeAgentCompartment(ChangeAgentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeAgentCompartmentRequest | 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<ChangeAgentCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeAgentCompartment API.
ChangeAgentDependencyCompartment(ChangeAgentDependencyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a AgentDependency resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeAgentDependencyCompartmentResponse> ChangeAgentDependencyCompartment(ChangeAgentDependencyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeAgentDependencyCompartmentRequest | 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<ChangeAgentDependencyCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeAgentDependencyCompartment API.
ChangeEnvironmentCompartment(ChangeEnvironmentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a source environment resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeEnvironmentCompartmentResponse> ChangeEnvironmentCompartment(ChangeEnvironmentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeEnvironmentCompartmentRequest | 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<ChangeEnvironmentCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeEnvironmentCompartment API.
CreateAgent(CreateAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates an Agent.
Declaration
public Task<CreateAgentResponse> CreateAgent(CreateAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAgentRequest | 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<CreateAgentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAgent API.
CreateAgentDependency(CreateAgentDependencyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates an AgentDependency.
Declaration
public Task<CreateAgentDependencyResponse> CreateAgentDependency(CreateAgentDependencyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAgentDependencyRequest | 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<CreateAgentDependencyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAgentDependency API.
CreateEnvironment(CreateEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a source environment.
Declaration
public Task<CreateEnvironmentResponse> CreateEnvironment(CreateEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateEnvironmentRequest | 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<CreateEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateEnvironment API.
DeleteAgent(DeleteAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes an Agent resource identified by an identifier.
Declaration
public Task<DeleteAgentResponse> DeleteAgent(DeleteAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAgentRequest | 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<DeleteAgentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAgent API.
DeleteAgentDependency(DeleteAgentDependencyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the AgentDependency resource based on an identifier.
Declaration
public Task<DeleteAgentDependencyResponse> DeleteAgentDependency(DeleteAgentDependencyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAgentDependencyRequest | 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<DeleteAgentDependencyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAgentDependency API.
DeleteEnvironment(DeleteEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a the source environment resource identified by an identifier.
Declaration
public Task<DeleteEnvironmentResponse> DeleteEnvironment(DeleteEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteEnvironmentRequest | 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<DeleteEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteEnvironment API.
GetAgent(GetAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets an Agent by identifier.
Declaration
public Task<GetAgentResponse> GetAgent(GetAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAgentRequest | 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<GetAgentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAgent API.
GetAgentDependency(GetAgentDependencyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets an AgentDependency by identifier.
Declaration
public Task<GetAgentDependencyResponse> GetAgentDependency(GetAgentDependencyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAgentDependencyRequest | 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<GetAgentDependencyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAgentDependency API.
GetEnvironment(GetEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a source environment by identifier.
Declaration
public Task<GetEnvironmentResponse> GetEnvironment(GetEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetEnvironmentRequest | 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<GetEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetEnvironment API.
GetPlugin(GetPluginRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a plugin by identifier.
Declaration
public Task<GetPluginResponse> GetPlugin(GetPluginRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPluginRequest | 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<GetPluginResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPlugin API.
ListAgentDependencies(ListAgentDependenciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of AgentDependencies such as AgentDependencyCollection.
Declaration
public Task<ListAgentDependenciesResponse> ListAgentDependencies(ListAgentDependenciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAgentDependenciesRequest | 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<ListAgentDependenciesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAgentDependencies API.
ListAgents(ListAgentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of Agents.
Declaration
public Task<ListAgentsResponse> ListAgents(ListAgentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAgentsRequest | 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<ListAgentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAgents API.
ListApplianceImages(ListApplianceImagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of Appliance Images.
Declaration
public Task<ListApplianceImagesResponse> ListApplianceImages(ListApplianceImagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListApplianceImagesRequest | 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<ListApplianceImagesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListApplianceImages API.
ListEnvironments(ListEnvironmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of source environments.
Declaration
public Task<ListEnvironmentsResponse> ListEnvironments(ListEnvironmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListEnvironmentsRequest | 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<ListEnvironmentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListEnvironments API.
RemoveAgentDependency(RemoveAgentDependencyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds a dependency to the source environment. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<RemoveAgentDependencyResponse> RemoveAgentDependency(RemoveAgentDependencyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveAgentDependencyRequest | 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<RemoveAgentDependencyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveAgentDependency API.
UpdateAgent(UpdateAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the Agent.
Declaration
public Task<UpdateAgentResponse> UpdateAgent(UpdateAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAgentRequest | 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<UpdateAgentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAgent API.
UpdateAgentDependency(UpdateAgentDependencyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the AgentDependency.
Declaration
public Task<UpdateAgentDependencyResponse> UpdateAgentDependency(UpdateAgentDependencyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAgentDependencyRequest | 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<UpdateAgentDependencyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAgentDependency API.
UpdateEnvironment(UpdateEnvironmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the source environment.
Declaration
public Task<UpdateEnvironmentResponse> UpdateEnvironment(UpdateEnvironmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateEnvironmentRequest | 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<UpdateEnvironmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateEnvironment API.
UpdatePlugin(UpdatePluginRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the plugin.
Declaration
public Task<UpdatePluginResponse> UpdatePlugin(UpdatePluginRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePluginRequest | 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<UpdatePluginResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePlugin API.