Class v1alpha2.GkeHubClient (2.1.0)

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

gkeHubStub

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

innerApiCalls

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

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

warn

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

Methods

checkCreateMembershipProgress(name)

checkCreateMembershipProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1alpha2.Membership, protos.google.cloud.gkehub.v1alpha2.OperationMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent (project and location) where the Memberships will be created.
   *  Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the membership. `membership_id` must be a valid RFC
   *  1123 compliant DNS label:
   *    1. At most 63 characters in length
   *    2. It must consist of lower case alphanumeric characters or `-`
   *    3. It must start and end with an alphanumeric character
   *  Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`,
   *  with a maximum length of 63 characters.
   */
  // const membershipId = 'abc123'
  /**
   *  Required. The membership to create.
   */
  // const resource = {}

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha2;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

  async function callCreateMembership() {
    // Construct request
    const request = {
      parent,
      membershipId,
      resource,
    };

    // Run request
    const [operation] = await gkehubClient.createMembership(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateMembership();

checkDeleteMembershipProgress(name)

checkDeleteMembershipProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkehub.v1alpha2.OperationMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha2;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

  async function callDeleteMembership() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await gkehubClient.deleteMembership(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteMembership();

checkUpdateMembershipProgress(name)

checkUpdateMembershipProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1alpha2.Membership, protos.google.cloud.gkehub.v1alpha2.OperationMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Only fields specified in update_mask are updated.
   *  If you specify a field in the update_mask but don't specify its value here
   *  that field will be deleted.
   *  If you are updating a map field, set the value of a key to null or empty
   *  string to delete the key from the map. It's not possible to update a key's
   *  value to the empty string.
   *  If you specify the update_mask to be a special path "*", fully replaces all
   *  user-modifiable fields to match `resource`.
   */
  // const resource = {}

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha2;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

  async function callUpdateMembership() {
    // Construct request
    const request = {
      name,
      updateMask,
      resource,
    };

    // Run request
    const [operation] = await gkehubClient.updateMembership(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateMembership();

close()

close(): Promise<void>;

createMembership(request, options)

createMembership(request?: protos.google.cloud.gkehub.v1alpha2.ICreateMembershipRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent (project and location) where the Memberships will be created.
   *  Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the membership. `membership_id` must be a valid RFC
   *  1123 compliant DNS label:
   *    1. At most 63 characters in length
   *    2. It must consist of lower case alphanumeric characters or `-`
   *    3. It must start and end with an alphanumeric character
   *  Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`,
   *  with a maximum length of 63 characters.
   */
  // const membershipId = 'abc123'
  /**
   *  Required. The membership to create.
   */
  // const resource = {}

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha2;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

  async function callCreateMembership() {
    // Construct request
    const request = {
      parent,
      membershipId,
      resource,
    };

    // Run request
    const [operation] = await gkehubClient.createMembership(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateMembership();

createMembership(request, options, callback)

createMembership(request: protos.google.cloud.gkehub.v1alpha2.ICreateMembershipRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

createMembership(request, callback)

createMembership(request: protos.google.cloud.gkehub.v1alpha2.ICreateMembershipRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteMembership(request, options)

deleteMembership(request?: protos.google.cloud.gkehub.v1alpha2.IDeleteMembershipRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha2;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

  async function callDeleteMembership() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await gkehubClient.deleteMembership(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteMembership();

deleteMembership(request, options, callback)

deleteMembership(request: protos.google.cloud.gkehub.v1alpha2.IDeleteMembershipRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteMembership(request, callback)

deleteMembership(request: protos.google.cloud.gkehub.v1alpha2.IDeleteMembershipRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

generateConnectManifest(request, options)

generateConnectManifest(request?: protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestResponse,
        (protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest | undefined),
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Membership resource name the Agent will associate with, in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'
  /**
   *  Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`.
   *  The Connect Agent is authorized automatically when run in the default
   *  namespace. Otherwise, explicit authorization must be granted with an
   *  additional IAM binding.
   */
  // const namespace = 'abc123'
  /**
   *  Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com
   *  requires the use of a proxy. Format must be in the form
   *  `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol
   *  supported by the proxy. This will direct the connect agent's outbound
   *  traffic through a HTTP(S) proxy.
   */
  // const proxy = 'Buffer.from('string')'
  /**
   *  Optional. The Connect agent version to use. Defaults to the most current version.
   */
  // const version = 'abc123'
  /**
   *  Optional. If true, generate the resources for upgrade only. Some resources
   *  generated only for installation (e.g. secrets) will be excluded.
   */
  // const isUpgrade = true
  /**
   *  Optional. The registry to fetch the connect agent image from. Defaults to
   *  gcr.io/gkeconnect.
   */
  // const registry = 'abc123'
  /**
   *  Optional. The image pull secret content for the registry, if not public.
   */
  // const imagePullSecretContent = 'Buffer.from('string')'

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha2;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

  async function callGenerateConnectManifest() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await gkehubClient.generateConnectManifest(request);
    console.log(response);
  }

  callGenerateConnectManifest();

generateConnectManifest(request, options, callback)

generateConnectManifest(request: protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestResponse, protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest | null | undefined, {} | null | undefined>): void;

generateConnectManifest(request, callback)

generateConnectManifest(request: protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestResponse, protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest | null | undefined, {} | null | undefined>): void;

getMembership(request, options)

getMembership(request?: protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1alpha2.IMembership,
        protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha2;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

  async function callGetMembership() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await gkehubClient.getMembership(request);
    console.log(response);
  }

  callGetMembership();

getMembership(request, options, callback)

getMembership(request: protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest | null | undefined, {} | null | undefined>): void;

getMembership(request, callback)

getMembership(request: protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

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

initialize()

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

initializeHub(request, options)

initializeHub(request?: protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1alpha2.IInitializeHubResponse,
        protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Hub to initialize, in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const project = 'my-project'

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha2;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

  async function callInitializeHub() {
    // Construct request
    const request = {
      project,
    };

    // Run request
    const response = await gkehubClient.initializeHub(request);
    console.log(response);
  }

  callInitializeHub();

initializeHub(request, options, callback)

initializeHub(request: protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IInitializeHubResponse, protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest | null | undefined, {} | null | undefined>): void;

initializeHub(request, callback)

initializeHub(request: protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IInitializeHubResponse, protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest | null | undefined, {} | null | undefined>): void;

listMemberships(request, options)

listMemberships(request?: protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1alpha2.IMembership[],
        protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest | null,
        protos.google.cloud.gkehub.v1alpha2.IListMembershipsResponse
    ]>;

listMemberships(request, options, callback)

listMemberships(request: protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, protos.google.cloud.gkehub.v1alpha2.IListMembershipsResponse | null | undefined, protos.google.cloud.gkehub.v1alpha2.IMembership>): void;

listMemberships(request, callback)

listMemberships(request: protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, callback: PaginationCallback<protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, protos.google.cloud.gkehub.v1alpha2.IListMembershipsResponse | null | undefined, protos.google.cloud.gkehub.v1alpha2.IMembership>): void;

listMembershipsAsync(request, options)

listMembershipsAsync(request?: protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1alpha2.IMembership>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent (project and location) where the Memberships will be listed.
   *  Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. When requesting a 'page' of resources, `page_size` specifies number of
   *  resources to return. If unspecified or set to 0, all resources will
   *  be returned.
   */
  // const pageSize = 1234
  /**
   *  Optional. Token returned by previous call to `ListMemberships` which
   *  specifies the position in the list from where to continue listing the
   *  resources.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Lists Memberships that match the filter expression, following the syntax
   *  outlined in https://google.aip.dev/160.
   *  Examples:
   *    - Name is `bar` in project `foo-proj` and location `global`:
   *        name = "projects/foo-proj/locations/global/membership/bar"
   *    - Memberships that have a label called `foo`:
   *        labels.foo:*
   *    - Memberships that have a label called `foo` whose value is `bar`:
   *        labels.foo = bar
   *    - Memberships in the CREATING state:
   *        state = CREATING
   */
  // const filter = 'abc123'
  /**
   *  Optional. One or more fields to compare and use to sort the output.
   *  See https://google.aip.dev/132#ordering.
   */
  // const orderBy = 'abc123'

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha2;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

  async function callListMemberships() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await gkehubClient.listMembershipsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListMemberships();

listMembershipsStream(request, options)

listMembershipsStream(request?: protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, options?: CallOptions): Transform;

locationPath(project, location)

locationPath(project: string, location: string): string;

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

matchLocationFromMembershipName(membershipName)

matchLocationFromMembershipName(membershipName: string): string | number;

matchMembershipFromMembershipName(membershipName)

matchMembershipFromMembershipName(membershipName: string): string | number;

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

matchProjectFromMembershipName(membershipName)

matchProjectFromMembershipName(membershipName: string): string | number;

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

membershipPath(project, location, membership)

membershipPath(project: string, location: string, membership: string): string;

projectPath(project)

projectPath(project: string): string;

updateMembership(request, options)

updateMembership(request?: protos.google.cloud.gkehub.v1alpha2.IUpdateMembershipRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. Only fields specified in update_mask are updated.
   *  If you specify a field in the update_mask but don't specify its value here
   *  that field will be deleted.
   *  If you are updating a map field, set the value of a key to null or empty
   *  string to delete the key from the map. It's not possible to update a key's
   *  value to the empty string.
   *  If you specify the update_mask to be a special path "*", fully replaces all
   *  user-modifiable fields to match `resource`.
   */
  // const resource = {}

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha2;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

  async function callUpdateMembership() {
    // Construct request
    const request = {
      name,
      updateMask,
      resource,
    };

    // Run request
    const [operation] = await gkehubClient.updateMembership(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateMembership();

updateMembership(request, options, callback)

updateMembership(request: protos.google.cloud.gkehub.v1alpha2.IUpdateMembershipRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

updateMembership(request, callback)

updateMembership(request: protos.google.cloud.gkehub.v1alpha2.IUpdateMembershipRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;