GatewayControl is the control plane API for Connect Gateway. v1beta1
Package
@google-cloud/gke-connect-gatewayConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of GatewayControlClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
gatewayControlStub
gatewayControlStub?: Promise<{
[name: string]: Function;
}>;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns | |
---|---|
Type | Description |
Promise<void> |
{Promise} A promise that resolves when the client is closed. |
generateCredentials(request, options)
generateCredentials(request?: protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest, options?: CallOptions): Promise<[
protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsResponse,
(protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest | undefined),
{} | undefined
]>;
GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.
Parameters | |
---|---|
Name | Description |
request |
IGenerateCredentialsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsResponse,
(protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerateCredentialsResponse. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Fleet membership resource.
*/
// const name = 'abc123'
/**
* Optional. Whether to force the use of Connect Agent-based transport.
* This will return a configuration that uses Connect Agent as the underlying
* transport mechanism for cluster types that would otherwise have used a
* different transport. Requires that Connect Agent be installed on the
* cluster. Setting this field to false is equivalent to not setting it.
*/
// const forceUseAgent = true
/**
* Optional. The Connect Gateway version to be used in the resulting
* configuration.
* Leave this field blank to let the server choose the version (recommended).
*/
// const version = 'abc123'
/**
* Optional. The namespace to use in the kubeconfig context.
* If this field is specified, the server will set the `namespace` field in
* kubeconfig context. If not specified, the `namespace` field is omitted.
*/
// const kubernetesNamespace = 'abc123'
/**
* Optional. The operating system where the kubeconfig will be used.
*/
// const operatingSystem = {}
// Imports the Gateway library
const {GatewayControlClient} = require('@google-cloud/gke-connect-gateway').v1beta1;
// Instantiates a client
const gatewayClient = new GatewayControlClient();
async function callGenerateCredentials() {
// Construct request
const request = {
name,
};
// Run request
const response = await gatewayClient.generateCredentials(request);
console.log(response);
}
callGenerateCredentials();
generateCredentials(request, options, callback)
generateCredentials(request: protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsResponse, protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGenerateCredentialsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsResponse, protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
generateCredentials(request, callback)
generateCredentials(request: protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest, callback: Callback<protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsResponse, protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGenerateCredentialsRequest
|
callback |
Callback<protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsResponse, protos.google.cloud.gkeconnect.gateway.v1beta1.IGenerateCredentialsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getProjectId()
getProjectId(): Promise<string>;
Returns | |
---|---|
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter | |
---|---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns | |
---|---|
Type | Description |
void |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns | |
---|---|
Type | Description |
Promise<{
[name: string]: Function;
}> |
{Promise} A promise that resolves to an authenticated service stub. |