Class v1.IdentityAwareProxyAdminServiceClient (1.0.1)

APIs for Identity-Aware Proxy Admin configurations. v1

Package

@google-cloud/iap!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of IdentityAwareProxyAdminServiceClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

identityAwareProxyAdminServiceStub

identityAwareProxyAdminServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(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.

getIamPolicy(request, options)

getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.IGetIamPolicyRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.iam.v1.IGetIamPolicyRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined ]>

getIamPolicy(request, options, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.IGetIamPolicyRequest
options CallOptions
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.IGetIamPolicyRequest
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getIapSettings(request, options)

getIapSettings(request?: protos.google.cloud.iap.v1.IGetIapSettingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.iap.v1.IIapSettings,
        protos.google.cloud.iap.v1.IGetIapSettingsRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.iap.v1.IGetIapSettingsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.iap.v1.IIapSettings, protos.google.cloud.iap.v1.IGetIapSettingsRequest | undefined, {} | undefined ]>

getIapSettings(request, options, callback)

getIapSettings(request: protos.google.cloud.iap.v1.IGetIapSettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.iap.v1.IIapSettings, protos.google.cloud.iap.v1.IGetIapSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.iap.v1.IGetIapSettingsRequest
options CallOptions
callback Callback<protos.google.cloud.iap.v1.IIapSettings, protos.google.cloud.iap.v1.IGetIapSettingsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getIapSettings(request, callback)

getIapSettings(request: protos.google.cloud.iap.v1.IGetIapSettingsRequest, callback: Callback<protos.google.cloud.iap.v1.IIapSettings, protos.google.cloud.iap.v1.IGetIapSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.iap.v1.IGetIapSettingsRequest
callback Callback<protos.google.cloud.iap.v1.IIapSettings, protos.google.cloud.iap.v1.IGetIapSettingsRequest | 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.

setIamPolicy(request, options)

setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.ISetIamPolicyRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.iam.v1.ISetIamPolicyRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined ]>

setIamPolicy(request, options, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.ISetIamPolicyRequest
options CallOptions
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

setIamPolicy(request, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.ISetIamPolicyRequest
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

testIamPermissions(request, options)

testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.ITestIamPermissionsResponse,
        protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.iam.v1.ITestIamPermissionsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined ]>

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.ITestIamPermissionsRequest
options CallOptions
callback Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.ITestIamPermissionsRequest
callback Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateIapSettings(request, options)

updateIapSettings(request?: protos.google.cloud.iap.v1.IUpdateIapSettingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.iap.v1.IIapSettings,
        protos.google.cloud.iap.v1.IUpdateIapSettingsRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.iap.v1.IUpdateIapSettingsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.iap.v1.IIapSettings, protos.google.cloud.iap.v1.IUpdateIapSettingsRequest | undefined, {} | undefined ]>

updateIapSettings(request, options, callback)

updateIapSettings(request: protos.google.cloud.iap.v1.IUpdateIapSettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.iap.v1.IIapSettings, protos.google.cloud.iap.v1.IUpdateIapSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.iap.v1.IUpdateIapSettingsRequest
options CallOptions
callback Callback<protos.google.cloud.iap.v1.IIapSettings, protos.google.cloud.iap.v1.IUpdateIapSettingsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateIapSettings(request, callback)

updateIapSettings(request: protos.google.cloud.iap.v1.IUpdateIapSettingsRequest, callback: Callback<protos.google.cloud.iap.v1.IIapSettings, protos.google.cloud.iap.v1.IUpdateIapSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.iap.v1.IUpdateIapSettingsRequest
callback Callback<protos.google.cloud.iap.v1.IIapSettings, protos.google.cloud.iap.v1.IUpdateIapSettingsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void