Class ApiMetadataClient

Service client instance for ApiMetadata.

Inheritance

object

ClientBase

RegionalClientBase

ApiMetadataClient

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.ApiaccesscontrolService

Assembly: OCI.DotNetSDK.Apiaccesscontrol.dll

Syntax

public class ApiMetadataClient : RegionalClientBase, IDisposable

Constructors

ApiMetadataClient(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 ApiMetadataClient(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 ApiMetadataPaginators Paginators { get; }

Property Value

Type	Description
ApiMetadataPaginators

Waiters

Declaration

public ApiMetadataWaiters Waiters { get; }

Property Value

Type	Description
ApiMetadataWaiters

Methods

GetApiMetadata(GetApiMetadataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a ApiMetadata.

Declaration

public Task<GetApiMetadataResponse> GetApiMetadata(GetApiMetadataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetApiMetadataRequest	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<GetApiMetadataResponse>	A response object containing details about the completed operation

Examples

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

ListApiMetadata(ListApiMetadataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of ApiMetadata.

Declaration

public Task<ListApiMetadataResponse> ListApiMetadata(ListApiMetadataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListApiMetadataRequest	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<ListApiMetadataResponse>	A response object containing details about the completed operation

Examples

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

ListApiMetadataByEntityTypes(ListApiMetadataByEntityTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of ApiMetadata Grouped By Entity Types.

Declaration

public Task<ListApiMetadataByEntityTypesResponse> ListApiMetadataByEntityTypes(ListApiMetadataByEntityTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListApiMetadataByEntityTypesRequest	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<ListApiMetadataByEntityTypesResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable