Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoverClusterClient

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

  • RoverClusterClient

Constructors

constructor

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

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 = "RoverCluster"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://rover.{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

changeRoverClusterCompartment

close

  • close(): void

createRoverCluster

  • Creates a new RoverCluster.

    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 CreateRoverCluster API.

    Parameters

    Returns Promise<CreateRoverClusterResponse>

    CreateRoverClusterResponse

createWaiters

  • Creates a new RoverClusterWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns RoverClusterWaiter

    The service waiters.

deleteRoverCluster

  • Deletes a RoverCluster 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 DeleteRoverCluster API.

    Parameters

    Returns Promise<DeleteRoverClusterResponse>

    DeleteRoverClusterResponse

getRoverCluster

  • Gets a RoverCluster 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 GetRoverCluster API.

    Parameters

    Returns Promise<GetRoverClusterResponse>

    GetRoverClusterResponse

getRoverClusterCertificate

getWaiters

listRoverClusters

  • Returns a list of RoverClusters.

    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 ListRoverClusters API.

    Parameters

    Returns Promise<ListRoverClustersResponse>

    ListRoverClustersResponse

requestAdditionalNodes

  • Submit additional nodes request for a roverCluster. 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 RequestAdditionalNodes API.

    Parameters

    Returns Promise<RequestAdditionalNodesResponse>

    RequestAdditionalNodesResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateRoverCluster

  • Updates the RoverCluster 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 UpdateRoverCluster API.

    Parameters

    Returns Promise<UpdateRoverClusterResponse>

    UpdateRoverClusterResponse