Class MetadataClient

Service client instance for Metadata.

Inheritance

object

ClientBase

RegionalClientBase

MetadataClient

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

Assembly: OCI.DotNetSDK.Multicloud.dll

Syntax

public class MetadataClient : RegionalClientBase, IDisposable

Constructors

MetadataClient(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 MetadataClient(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 MetadataPaginators Paginators { get; }

Property Value

Type	Description
MetadataPaginators

Methods

ListExternalLocationDetailsMetadata(ListExternalLocationDetailsMetadataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List externalLocationDetail metadata from OCI to Cloud Service Provider for regions, Availability Zones, and Cluster Placement Group ID. examples: application-json: | [ { "externalLocation": { "cspRegion": "East US", "cspPhysicalAz": "az1-xyz", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az1", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-1 or aws-account-id-1, gcp-project-id-1" } }, "ociPhysicalAd": "ad1-xyb", "ociLogicalAd": "ad2", "ociRegion": "us-ashburn-1", "cpgId": "cpg-1" }, { "externalLocation": { "cspRegion": "East US", "cspPhysicalAz": "az2-abc", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az2", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-2 or aws-account-id-2, gcp-project-id-2" } }, "ociPhysicalAd": "ad2-xby", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1", "cpgId": "cpg-2" }, { "externalLocation": { "cspRegion": "East US", "cspPhysicalAz": "az3-abz", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az3", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-3 or aws-account-id-3, gcp-project-id-3" } }, "ociPhysicalAd": "ad3-cde", "ociLogicalAd": "ad3", "ociRegion": "us-ashburn-1", "cpgId": "cpg-3" }, { "externalLocation": { "cspRegion": "East US 2", "cspPhysicalAz": "az1-def", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az1", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-4 or aws-account-id-4, gcp-project-id-4" } }, "ociPhysicalAd": "ad1-bce", "ociLogicalAd": "ad2", "ociRegion": "us-ashburn-1", "cpgId": "cpg-4" }, { "externalLocation": { "cspRegion": "East US 2", "cspPhysicalAz": "az2-uvw", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az2", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-3 or aws-account-id-3, gcp-project-id-3" } }, "ociPhysicalAd": "ad2-ftc", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1", "cpgId": "cpg-5" }, { "externalLocation": { "cspRegion": "East US 2", "cspPhysicalAz": "az3-uvw", "cspPhysicalAzDisplayName": "(US) East US 2", "cspLogicalAz": "az3", "serviceName": "ORACLEDBATAZURE", "cspZoneKeyReferenceId": { "keyName": "AzureSubscriptionId or AwsAccountId, GcpProjectName", "keyValue": "azure-subscriptionId-3 or aws-account-id-3, gcp-project-id-3" } }, "ociPhysicalAd": "ad3-stc", "ociLogicalAd": "ad3", "ociRegion": "us-ashburn-1", "cpgId": "cpg-6" } ]

Declaration

public Task<ListExternalLocationDetailsMetadataResponse> ListExternalLocationDetailsMetadata(ListExternalLocationDetailsMetadataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListExternalLocationMappingMetadata(ListExternalLocationMappingMetadataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List externalLocation metadata from OCI to the Cloud Service Provider for regions, Physical Availability Zones. examples: application-json: | [ { "externalLocation": { "cspRegion": "eastus", "cspPhysicalAz": "eastus-az1", "cspPhysicalAzDisplayName": "(US) East US 1", "serviceName": "ORACLEDBATAZURE" }, "ociPhysicalAd": "iad-ad-1", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1" }, { "externalLocation": { "cspRegion": "eastus", "cspPhysicalAz": "eastus-az1", "cspPhysicalAzDisplayName": "(US) East US 1", "serviceName": "ORACLEDBATAZURE" }, "ociPhysicalAd": "iad-ad-1", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1" }, { "externalLocation": { "cspRegion": "eastus2", "cspPhysicalAz": "eastus2-az3", "cspPhysicalAzDisplayName": "(US) East US 1", "serviceName": "ORACLEDBATAZURE" }, "ociPhysicalAd": "iad-ad-2", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1" }, { "externalLocation": { "cspRegion": "eastus", "cspPhysicalAz": "eastus-az3" "cspPhysicalAzDisplayName": "(US) East US 1", "serviceName": "ORACLEDBATAZURE" }, "ociPhysicalAd": "iad-ad-333", "ociLogicalAd": "ad1", "ociRegion": "us-ashburn-1" } ]

Declaration

public Task<ListExternalLocationMappingMetadataResponse> ListExternalLocationMappingMetadata(ListExternalLocationMappingMetadataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListExternalLocationSummariesMetadata(ListExternalLocationSummariesMetadataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List externalLocationSummary metadata from OCI Region to the Cloud Service Provider region across all regions. examples: application-json: | [ { "externalLocation": { "cspRegion": "East US" }, "ociRegion": "us-ashburn-1" }, { "externalLocation": { "cspRegion": "East US 2" }, "ociRegion": "us-ashburn-1" }, { "externalLocation": { "cspRegion": "Germany West Central" }, "ociRegion": "eu-frankfurt-1", } ]

Declaration

public Task<ListExternalLocationSummariesMetadataResponse> ListExternalLocationSummariesMetadata(ListExternalLocationSummariesMetadataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable