Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceMeshClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • ServiceMeshClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new ServiceMeshClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): ServiceMeshClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "ServiceMesh"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://servicemesh.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

cancelWorkRequest

  • Cancels the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelWorkRequest API.

    Parameters

    Returns Promise<CancelWorkRequestResponse>

    CancelWorkRequestResponse

changeAccessPolicyCompartment

  • Moves an AccessPolicy resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeAccessPolicyCompartment API.

    Parameters

    Returns Promise<ChangeAccessPolicyCompartmentResponse>

    ChangeAccessPolicyCompartmentResponse

changeIngressGatewayCompartment

  • Moves a IngressGateway resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeIngressGatewayCompartment API.

    Parameters

    Returns Promise<ChangeIngressGatewayCompartmentResponse>

    ChangeIngressGatewayCompartmentResponse

changeIngressGatewayRouteTableCompartment

  • Moves a IngressGatewayRouteTable resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeIngressGatewayRouteTableCompartment API.

    Parameters

    Returns Promise<ChangeIngressGatewayRouteTableCompartmentResponse>

    ChangeIngressGatewayRouteTableCompartmentResponse

changeMeshCompartment

  • Moves a Mesh resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeMeshCompartment API.

    Parameters

    Returns Promise<ChangeMeshCompartmentResponse>

    ChangeMeshCompartmentResponse

changeVirtualDeploymentCompartment

  • Moves a VirtualDeployment resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeVirtualDeploymentCompartment API.

    Parameters

    Returns Promise<ChangeVirtualDeploymentCompartmentResponse>

    ChangeVirtualDeploymentCompartmentResponse

changeVirtualServiceCompartment

  • Moves a VirtualService resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeVirtualServiceCompartment API.

    Parameters

    Returns Promise<ChangeVirtualServiceCompartmentResponse>

    ChangeVirtualServiceCompartmentResponse

changeVirtualServiceRouteTableCompartment

  • Moves a VirtualServiceRouteTable resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeVirtualServiceRouteTableCompartment API.

    Parameters

    Returns Promise<ChangeVirtualServiceRouteTableCompartmentResponse>

    ChangeVirtualServiceRouteTableCompartmentResponse

close

  • close(): void

createAccessPolicy

createIngressGateway

createIngressGatewayRouteTable

createMesh

  • Creates a new Mesh.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateMesh API.

    Parameters

    Returns Promise<CreateMeshResponse>

    CreateMeshResponse

createVirtualDeployment

createVirtualService

createVirtualServiceRouteTable

createWaiters

  • Creates a new ServiceMeshWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns ServiceMeshWaiter

    The service waiters.

deleteAccessPolicy

  • Deletes an AccessPolicy resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAccessPolicy API.

    Parameters

    Returns Promise<DeleteAccessPolicyResponse>

    DeleteAccessPolicyResponse

deleteIngressGateway

deleteIngressGatewayRouteTable

deleteMesh

  • Deletes a Mesh resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteMesh API.

    Parameters

    Returns Promise<DeleteMeshResponse>

    DeleteMeshResponse

deleteVirtualDeployment

deleteVirtualService

deleteVirtualServiceRouteTable

getAccessPolicy

  • Get an AccessPolicy by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAccessPolicy API.

    Parameters

    Returns Promise<GetAccessPolicyResponse>

    GetAccessPolicyResponse

getIngressGateway

getIngressGatewayRouteTable

getMesh

  • Gets a Mesh by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetMesh API.

    Parameters

    Returns Promise<GetMeshResponse>

    GetMeshResponse

getProxyDetails

  • Returns the attributes of the Proxy such as proxy image version.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetProxyDetails API.

    Parameters

    Returns Promise<GetProxyDetailsResponse>

    GetProxyDetailsResponse

getVirtualDeployment

getVirtualService

getVirtualServiceRouteTable

getWaiters

getWorkRequest

  • Gets the status of the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listAccessPolicies

listIngressGatewayRouteTables

listIngressGateways

listMeshes

  • Returns a list of Mesh objects.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMeshes API.

    Parameters

    Returns Promise<ListMeshesResponse>

    ListMeshesResponse

listVirtualDeployments

listVirtualServiceRouteTables

listVirtualServices

listWorkRequestErrors

  • Return a (paginated) list of errors for a given work request.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

  • Return a (paginated) list of logs for a given work request.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • Lists the work requests in a compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateAccessPolicy

updateIngressGateway

updateIngressGatewayRouteTable

updateMesh

  • Updates the Mesh. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateMesh API.

    Parameters

    Returns Promise<UpdateMeshResponse>

    UpdateMeshResponse

updateVirtualDeployment

updateVirtualService

updateVirtualServiceRouteTable