Class v1.ServiceControllerClient (3.3.0)

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Properties

apiEndpoint

get apiEndpoint(): string;

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

port

static get port(): number;

scopes

static get scopes(): string[];

serviceControllerStub

serviceControllerStub?: Promise<{
        [name: string]: Function;
    }>;

servicePath

static get servicePath(): string;

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

check(request, options)

check(request?: protos.google.api.servicecontrol.v1.ICheckRequest, options?: CallOptions): Promise<[
        protos.google.api.servicecontrol.v1.ICheckResponse,
        protos.google.api.servicecontrol.v1.ICheckRequest | undefined,
        {} | undefined
    ]>;

  /**
   * 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.
   */
  /**
   *  The service name as specified in its service configuration. For example,
   *  `"pubsub.googleapis.com"`.
   *  See
   *  google.api.Service (https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)
   *  for the definition of a service name.
   */
  // const serviceName = 'abc123'
  /**
   *  The operation to be checked.
   */
  // const operation = {}
  /**
   *  Specifies which version of service configuration should be used to process
   *  the request.
   *  If unspecified or no matching version can be found, the
   *  latest one will be used.
   */
  // const serviceConfigId = 'abc123'

  // Imports the Servicecontrol library
  const {ServiceControllerClient} = require('@google-cloud/service-control').v1;

  // Instantiates a client
  const servicecontrolClient = new ServiceControllerClient();

  async function callCheck() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await servicecontrolClient.check(request);
    console.log(response);
  }

  callCheck();

check(request, options, callback)

check(request: protos.google.api.servicecontrol.v1.ICheckRequest, options: CallOptions, callback: Callback<protos.google.api.servicecontrol.v1.ICheckResponse, protos.google.api.servicecontrol.v1.ICheckRequest | null | undefined, {} | null | undefined>): void;

check(request, callback)

check(request: protos.google.api.servicecontrol.v1.ICheckRequest, callback: Callback<protos.google.api.servicecontrol.v1.ICheckResponse, protos.google.api.servicecontrol.v1.ICheckRequest | null | undefined, {} | null | undefined>): void;

close()

close(): Promise<void>;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

report(request, options)

report(request?: protos.google.api.servicecontrol.v1.IReportRequest, options?: CallOptions): Promise<[
        protos.google.api.servicecontrol.v1.IReportResponse,
        protos.google.api.servicecontrol.v1.IReportRequest | undefined,
        {} | undefined
    ]>;

  /**
   * 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.
   */
  /**
   *  The service name as specified in its service configuration. For example,
   *  `"pubsub.googleapis.com"`.
   *  See
   *  google.api.Service (https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)
   *  for the definition of a service name.
   */
  // const serviceName = 'abc123'
  /**
   *  Operations to be reported.
   *  Typically the service should report one operation per request.
   *  Putting multiple operations into a single request is allowed, but should
   *  be used only when multiple operations are natually available at the time
   *  of the report.
   *  There is no limit on the number of operations in the same ReportRequest,
   *  however the ReportRequest size should be no larger than 1MB. See
   *  ReportResponse.report_errors google.api.servicecontrol.v1.ReportResponse.report_errors 
   *  for partial failure behavior.
   */
  // const operations = [1,2,3,4]
  /**
   *  Specifies which version of service config should be used to process the
   *  request.
   *  If unspecified or no matching version can be found, the
   *  latest one will be used.
   */
  // const serviceConfigId = 'abc123'

  // Imports the Servicecontrol library
  const {ServiceControllerClient} = require('@google-cloud/service-control').v1;

  // Instantiates a client
  const servicecontrolClient = new ServiceControllerClient();

  async function callReport() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await servicecontrolClient.report(request);
    console.log(response);
  }

  callReport();

report(request, options, callback)

report(request: protos.google.api.servicecontrol.v1.IReportRequest, options: CallOptions, callback: Callback<protos.google.api.servicecontrol.v1.IReportResponse, protos.google.api.servicecontrol.v1.IReportRequest | null | undefined, {} | null | undefined>): void;

report(request, callback)

report(request: protos.google.api.servicecontrol.v1.IReportRequest, callback: Callback<protos.google.api.servicecontrol.v1.IReportResponse, protos.google.api.servicecontrol.v1.IReportRequest | null | undefined, {} | null | undefined>): void;