Backstage
Docs
Github
Preparing search index...
@backstage/plugin-kubernetes-react
index
KubernetesApi
Interface KubernetesApi
interface
KubernetesApi
{
getCluster
(
clusterName
:
string
,
)
:
Promise
<
|
{
authProvider
:
string
;
dashboardUrl
?:
string
;
name
:
string
;
oidcTokenProvider
?:
string
;
}
|
undefined
,
>
;
getClusters
()
:
Promise
<
{
authProvider
:
string
;
name
:
string
;
oidcTokenProvider
?:
string
}
[]
,
>
;
getCustomObjectsByEntity
(
request
:
CustomObjectsByEntityRequest
,
)
:
Promise
<
ObjectsByEntityResponse
>
;
getObjectsByEntity
(
requestBody
:
KubernetesRequestBody
,
)
:
Promise
<
ObjectsByEntityResponse
>
;
getWorkloadsByEntity
(
request
:
WorkloadsByEntityRequest
,
)
:
Promise
<
ObjectsByEntityResponse
>
;
proxy
(
options
:
{
clusterName
:
string
;
init
?:
RequestInit
;
path
:
string
}
,
)
:
Promise
<
Response
>
;
}
Implemented by
KubernetesBackendClient
Index
Methods
get
Cluster
get
Clusters
get
Custom
Objects
By
Entity
get
Objects
By
Entity
get
Workloads
By
Entity
proxy
Methods
get
Cluster
getCluster
(
clusterName
:
string
,
)
:
Promise
<
|
{
authProvider
:
string
;
dashboardUrl
?:
string
;
name
:
string
;
oidcTokenProvider
?:
string
;
}
|
undefined
,
>
Parameters
clusterName
:
string
Returns
Promise
<
|
{
authProvider
:
string
;
dashboardUrl
?:
string
;
name
:
string
;
oidcTokenProvider
?:
string
;
}
|
undefined
,
>
get
Clusters
getClusters
()
:
Promise
<
{
authProvider
:
string
;
name
:
string
;
oidcTokenProvider
?:
string
}
[]
,
>
Returns
Promise
<
{
authProvider
:
string
;
name
:
string
;
oidcTokenProvider
?:
string
}
[]
>
get
Custom
Objects
By
Entity
getCustomObjectsByEntity
(
request
:
CustomObjectsByEntityRequest
,
)
:
Promise
<
ObjectsByEntityResponse
>
Parameters
request
:
CustomObjectsByEntityRequest
Returns
Promise
<
ObjectsByEntityResponse
>
get
Objects
By
Entity
getObjectsByEntity
(
requestBody
:
KubernetesRequestBody
,
)
:
Promise
<
ObjectsByEntityResponse
>
Parameters
requestBody
:
KubernetesRequestBody
Returns
Promise
<
ObjectsByEntityResponse
>
get
Workloads
By
Entity
getWorkloadsByEntity
(
request
:
WorkloadsByEntityRequest
,
)
:
Promise
<
ObjectsByEntityResponse
>
Parameters
request
:
WorkloadsByEntityRequest
Returns
Promise
<
ObjectsByEntityResponse
>
proxy
proxy
(
options
:
{
clusterName
:
string
;
init
?:
RequestInit
;
path
:
string
}
,
)
:
Promise
<
Response
>
Parameters
options
:
{
clusterName
:
string
;
init
?:
RequestInit
;
path
:
string
}
Returns
Promise
<
Response
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
get
Cluster
get
Clusters
get
Custom
Objects
By
Entity
get
Objects
By
Entity
get
Workloads
By
Entity
proxy
Docs
Github
Backstage
Loading...