Class v1.StorageTransferServiceClient (3.0.0)

Package

Constructors

(constructor)(opts, gaxInstance)

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

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

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;

storageTransferServiceStub

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

warn

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

Methods

agentPoolsPath(projectId, agentPoolId)

agentPoolsPath(projectId: string, agentPoolId: string): string;

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkRunTransferJobProgress(name)

checkRunTransferJobProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.storagetransfer.v1.TransferOperation>>;

  /**
   * 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 name of the transfer job.
   */
  // const jobName = 'abc123'
  /**
   *  Required. The ID of the Google Cloud project that owns the transfer
   *  job.
   */
  // const projectId = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

  async function callRunTransferJob() {
    // Construct request
    const request = {
      jobName,
      projectId,
    };

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

  callRunTransferJob();

close()

close(): Promise<void>;

createAgentPool(request, options)

createAgentPool(request?: protos.google.storagetransfer.v1.ICreateAgentPoolRequest, options?: CallOptions): Promise<[
        protos.google.storagetransfer.v1.IAgentPool,
        protos.google.storagetransfer.v1.ICreateAgentPoolRequest | 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.
   */
  /**
   *  Required. The ID of the Google Cloud project that owns the
   *  agent pool.
   */
  // const projectId = 'abc123'
  /**
   *  Required. The agent pool to create.
   */
  // const agentPool = {}
  /**
   *  Required. The ID of the agent pool to create.
   *  The `agent_pool_id` must meet the following requirements:
   *  *   Length of 128 characters or less.
   *  *   Not start with the string `goog`.
   *  *   Start with a lowercase ASCII character, followed by:
   *      *   Zero or more: lowercase Latin alphabet characters, numerals,
   *          hyphens (`-`), periods (`.`), underscores (`_`), or tildes (`~`).
   *      *   One or more numerals or lowercase ASCII characters.
   *  As expressed by the regular expression:
   *  `^(?!goog)a-z(a-z0-9-._~*a-z0-9)?$`.
   */
  // const agentPoolId = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

  async function callCreateAgentPool() {
    // Construct request
    const request = {
      projectId,
      agentPool,
      agentPoolId,
    };

    // Run request
    const response = await storagetransferClient.createAgentPool(request);
    console.log(response);
  }

  callCreateAgentPool();

createAgentPool(request, options, callback)

createAgentPool(request: protos.google.storagetransfer.v1.ICreateAgentPoolRequest, options: CallOptions, callback: Callback<protos.google.storagetransfer.v1.IAgentPool, protos.google.storagetransfer.v1.ICreateAgentPoolRequest | null | undefined, {} | null | undefined>): void;

createAgentPool(request, callback)

createAgentPool(request: protos.google.storagetransfer.v1.ICreateAgentPoolRequest, callback: Callback<protos.google.storagetransfer.v1.IAgentPool, protos.google.storagetransfer.v1.ICreateAgentPoolRequest | null | undefined, {} | null | undefined>): void;

createTransferJob(request, options)

createTransferJob(request?: protos.google.storagetransfer.v1.ICreateTransferJobRequest, options?: CallOptions): Promise<[
        protos.google.storagetransfer.v1.ITransferJob,
        protos.google.storagetransfer.v1.ICreateTransferJobRequest | 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.
   */
  /**
   *  Required. The job to create.
   */
  // const transferJob = {}

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

  async function callCreateTransferJob() {
    // Construct request
    const request = {
      transferJob,
    };

    // Run request
    const response = await storagetransferClient.createTransferJob(request);
    console.log(response);
  }

  callCreateTransferJob();

createTransferJob(request, options, callback)

createTransferJob(request: protos.google.storagetransfer.v1.ICreateTransferJobRequest, options: CallOptions, callback: Callback<protos.google.storagetransfer.v1.ITransferJob, protos.google.storagetransfer.v1.ICreateTransferJobRequest | null | undefined, {} | null | undefined>): void;

createTransferJob(request, callback)

createTransferJob(request: protos.google.storagetransfer.v1.ICreateTransferJobRequest, callback: Callback<protos.google.storagetransfer.v1.ITransferJob, protos.google.storagetransfer.v1.ICreateTransferJobRequest | null | undefined, {} | null | undefined>): void;

deleteAgentPool(request, options)

deleteAgentPool(request?: protos.google.storagetransfer.v1.IDeleteAgentPoolRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.storagetransfer.v1.IDeleteAgentPoolRequest | 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.
   */
  /**
   *  Required. The name of the agent pool to delete.
   */
  // const name = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

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

    // Run request
    const response = await storagetransferClient.deleteAgentPool(request);
    console.log(response);
  }

  callDeleteAgentPool();

deleteAgentPool(request, options, callback)

deleteAgentPool(request: protos.google.storagetransfer.v1.IDeleteAgentPoolRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.storagetransfer.v1.IDeleteAgentPoolRequest | null | undefined, {} | null | undefined>): void;

deleteAgentPool(request, callback)

deleteAgentPool(request: protos.google.storagetransfer.v1.IDeleteAgentPoolRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.storagetransfer.v1.IDeleteAgentPoolRequest | null | undefined, {} | null | undefined>): void;

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

deleteTransferJob(request, options)

deleteTransferJob(request?: protos.google.storagetransfer.v1.IDeleteTransferJobRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.storagetransfer.v1.IDeleteTransferJobRequest | 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.
   */
  /**
   *  Required. The job to delete.
   */
  // const jobName = 'abc123'
  /**
   *  Required. The ID of the Google Cloud project that owns the
   *  job.
   */
  // const projectId = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

  async function callDeleteTransferJob() {
    // Construct request
    const request = {
      jobName,
      projectId,
    };

    // Run request
    const response = await storagetransferClient.deleteTransferJob(request);
    console.log(response);
  }

  callDeleteTransferJob();

deleteTransferJob(request, options, callback)

deleteTransferJob(request: protos.google.storagetransfer.v1.IDeleteTransferJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.storagetransfer.v1.IDeleteTransferJobRequest | null | undefined, {} | null | undefined>): void;

deleteTransferJob(request, callback)

deleteTransferJob(request: protos.google.storagetransfer.v1.IDeleteTransferJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.storagetransfer.v1.IDeleteTransferJobRequest | null | undefined, {} | null | undefined>): void;

getAgentPool(request, options)

getAgentPool(request?: protos.google.storagetransfer.v1.IGetAgentPoolRequest, options?: CallOptions): Promise<[
        protos.google.storagetransfer.v1.IAgentPool,
        protos.google.storagetransfer.v1.IGetAgentPoolRequest | 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.
   */
  /**
   *  Required. The name of the agent pool to get.
   */
  // const name = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

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

    // Run request
    const response = await storagetransferClient.getAgentPool(request);
    console.log(response);
  }

  callGetAgentPool();

getAgentPool(request, options, callback)

getAgentPool(request: protos.google.storagetransfer.v1.IGetAgentPoolRequest, options: CallOptions, callback: Callback<protos.google.storagetransfer.v1.IAgentPool, protos.google.storagetransfer.v1.IGetAgentPoolRequest | null | undefined, {} | null | undefined>): void;

getAgentPool(request, callback)

getAgentPool(request: protos.google.storagetransfer.v1.IGetAgentPoolRequest, callback: Callback<protos.google.storagetransfer.v1.IAgentPool, protos.google.storagetransfer.v1.IGetAgentPoolRequest | null | undefined, {} | null | undefined>): void;

getGoogleServiceAccount(request, options)

getGoogleServiceAccount(request?: protos.google.storagetransfer.v1.IGetGoogleServiceAccountRequest, options?: CallOptions): Promise<[
        protos.google.storagetransfer.v1.IGoogleServiceAccount,
        (protos.google.storagetransfer.v1.IGetGoogleServiceAccountRequest | 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.
   */
  /**
   *  Required. The ID of the Google Cloud project that the Google service
   *  account is associated with.
   */
  // const projectId = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

  async function callGetGoogleServiceAccount() {
    // Construct request
    const request = {
      projectId,
    };

    // Run request
    const response = await storagetransferClient.getGoogleServiceAccount(request);
    console.log(response);
  }

  callGetGoogleServiceAccount();

getGoogleServiceAccount(request, options, callback)

getGoogleServiceAccount(request: protos.google.storagetransfer.v1.IGetGoogleServiceAccountRequest, options: CallOptions, callback: Callback<protos.google.storagetransfer.v1.IGoogleServiceAccount, protos.google.storagetransfer.v1.IGetGoogleServiceAccountRequest | null | undefined, {} | null | undefined>): void;

getGoogleServiceAccount(request, callback)

getGoogleServiceAccount(request: protos.google.storagetransfer.v1.IGetGoogleServiceAccountRequest, callback: Callback<protos.google.storagetransfer.v1.IGoogleServiceAccount, protos.google.storagetransfer.v1.IGetGoogleServiceAccountRequest | null | undefined, {} | null | undefined>): void;

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

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

getTransferJob(request, options)

getTransferJob(request?: protos.google.storagetransfer.v1.IGetTransferJobRequest, options?: CallOptions): Promise<[
        protos.google.storagetransfer.v1.ITransferJob,
        protos.google.storagetransfer.v1.IGetTransferJobRequest | 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.
   */
  /**
   *  Required. The job to get.
   */
  // const jobName = 'abc123'
  /**
   *  Required. The ID of the Google Cloud project that owns the
   *  job.
   */
  // const projectId = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

  async function callGetTransferJob() {
    // Construct request
    const request = {
      jobName,
      projectId,
    };

    // Run request
    const response = await storagetransferClient.getTransferJob(request);
    console.log(response);
  }

  callGetTransferJob();

getTransferJob(request, options, callback)

getTransferJob(request: protos.google.storagetransfer.v1.IGetTransferJobRequest, options: CallOptions, callback: Callback<protos.google.storagetransfer.v1.ITransferJob, protos.google.storagetransfer.v1.IGetTransferJobRequest | null | undefined, {} | null | undefined>): void;

getTransferJob(request, callback)

getTransferJob(request: protos.google.storagetransfer.v1.IGetTransferJobRequest, callback: Callback<protos.google.storagetransfer.v1.ITransferJob, protos.google.storagetransfer.v1.IGetTransferJobRequest | null | undefined, {} | null | undefined>): void;

initialize()

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

listAgentPools(request, options)

listAgentPools(request?: protos.google.storagetransfer.v1.IListAgentPoolsRequest, options?: CallOptions): Promise<[
        protos.google.storagetransfer.v1.IAgentPool[],
        protos.google.storagetransfer.v1.IListAgentPoolsRequest | null,
        protos.google.storagetransfer.v1.IListAgentPoolsResponse
    ]>;

listAgentPools(request, options, callback)

listAgentPools(request: protos.google.storagetransfer.v1.IListAgentPoolsRequest, options: CallOptions, callback: PaginationCallback<protos.google.storagetransfer.v1.IListAgentPoolsRequest, protos.google.storagetransfer.v1.IListAgentPoolsResponse | null | undefined, protos.google.storagetransfer.v1.IAgentPool>): void;

listAgentPools(request, callback)

listAgentPools(request: protos.google.storagetransfer.v1.IListAgentPoolsRequest, callback: PaginationCallback<protos.google.storagetransfer.v1.IListAgentPoolsRequest, protos.google.storagetransfer.v1.IListAgentPoolsResponse | null | undefined, protos.google.storagetransfer.v1.IAgentPool>): void;

listAgentPoolsAsync(request, options)

listAgentPoolsAsync(request?: protos.google.storagetransfer.v1.IListAgentPoolsRequest, options?: CallOptions): AsyncIterable<protos.google.storagetransfer.v1.IAgentPool>;

  /**
   * 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 ID of the Google Cloud project that owns the job.
   */
  // const projectId = 'abc123'
  /**
   *  An optional list of query parameters specified as JSON text in the
   *  form of:
   *  `{"agentPoolNames":"agentpool1","agentpool2",... }`
   *  Since `agentPoolNames` support multiple values, its values must be
   *  specified with array notation. When the filter is either empty or not
   *  provided, the list returns all agent pools for the project.
   */
  // const filter = 'abc123'
  /**
   *  The list page size. The max allowed value is `256`.
   */
  // const pageSize = 1234
  /**
   *  The list page token.
   */
  // const pageToken = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

  async function callListAgentPools() {
    // Construct request
    const request = {
      projectId,
    };

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

  callListAgentPools();

listAgentPoolsStream(request, options)

listAgentPoolsStream(request?: protos.google.storagetransfer.v1.IListAgentPoolsRequest, options?: CallOptions): Transform;

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

listTransferJobs(request, options)

listTransferJobs(request?: protos.google.storagetransfer.v1.IListTransferJobsRequest, options?: CallOptions): Promise<[
        protos.google.storagetransfer.v1.ITransferJob[],
        protos.google.storagetransfer.v1.IListTransferJobsRequest | null,
        protos.google.storagetransfer.v1.IListTransferJobsResponse
    ]>;

listTransferJobs(request, options, callback)

listTransferJobs(request: protos.google.storagetransfer.v1.IListTransferJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.storagetransfer.v1.IListTransferJobsRequest, protos.google.storagetransfer.v1.IListTransferJobsResponse | null | undefined, protos.google.storagetransfer.v1.ITransferJob>): void;

listTransferJobs(request, callback)

listTransferJobs(request: protos.google.storagetransfer.v1.IListTransferJobsRequest, callback: PaginationCallback<protos.google.storagetransfer.v1.IListTransferJobsRequest, protos.google.storagetransfer.v1.IListTransferJobsResponse | null | undefined, protos.google.storagetransfer.v1.ITransferJob>): void;

listTransferJobsAsync(request, options)

listTransferJobsAsync(request?: protos.google.storagetransfer.v1.IListTransferJobsRequest, options?: CallOptions): AsyncIterable<protos.google.storagetransfer.v1.ITransferJob>;

  /**
   * 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. A list of query parameters specified as JSON text in the form of:
   *  `{"projectId":"my_project_id",
   *   "jobNames":"jobid1","jobid2",...,
   *   "jobStatuses":"status1","status2",... }`
   *  Since `jobNames` and `jobStatuses` support multiple values, their values
   *  must be specified with array notation. `projectId` is required.
   *  `jobNames` and `jobStatuses` are optional.  The valid values for
   *  `jobStatuses` are case-insensitive:
   *  ENABLED google.storagetransfer.v1.TransferJob.Status.ENABLED,
   *  DISABLED google.storagetransfer.v1.TransferJob.Status.DISABLED, and
   *  DELETED google.storagetransfer.v1.TransferJob.Status.DELETED.
   */
  // const filter = 'abc123'
  /**
   *  The list page size. The max allowed value is 256.
   */
  // const pageSize = 1234
  /**
   *  The list page token.
   */
  // const pageToken = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

  async function callListTransferJobs() {
    // Construct request
    const request = {
      filter,
    };

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

  callListTransferJobs();

listTransferJobsStream(request, options)

listTransferJobsStream(request?: protos.google.storagetransfer.v1.IListTransferJobsRequest, options?: CallOptions): Transform;

matchAgentPoolIdFromAgentPoolsName(agentPoolsName)

matchAgentPoolIdFromAgentPoolsName(agentPoolsName: string): string | number;

matchProjectIdFromAgentPoolsName(agentPoolsName)

matchProjectIdFromAgentPoolsName(agentPoolsName: string): string | number;

pauseTransferOperation(request, options)

pauseTransferOperation(request?: protos.google.storagetransfer.v1.IPauseTransferOperationRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.storagetransfer.v1.IPauseTransferOperationRequest | 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.
   */
  /**
   *  Required. The name of the transfer operation.
   */
  // const name = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

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

    // Run request
    const response = await storagetransferClient.pauseTransferOperation(request);
    console.log(response);
  }

  callPauseTransferOperation();

pauseTransferOperation(request, options, callback)

pauseTransferOperation(request: protos.google.storagetransfer.v1.IPauseTransferOperationRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.storagetransfer.v1.IPauseTransferOperationRequest | null | undefined, {} | null | undefined>): void;

pauseTransferOperation(request, callback)

pauseTransferOperation(request: protos.google.storagetransfer.v1.IPauseTransferOperationRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.storagetransfer.v1.IPauseTransferOperationRequest | null | undefined, {} | null | undefined>): void;

resumeTransferOperation(request, options)

resumeTransferOperation(request?: protos.google.storagetransfer.v1.IResumeTransferOperationRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.storagetransfer.v1.IResumeTransferOperationRequest | 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.
   */
  /**
   *  Required. The name of the transfer operation.
   */
  // const name = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

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

    // Run request
    const response = await storagetransferClient.resumeTransferOperation(request);
    console.log(response);
  }

  callResumeTransferOperation();

resumeTransferOperation(request, options, callback)

resumeTransferOperation(request: protos.google.storagetransfer.v1.IResumeTransferOperationRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.storagetransfer.v1.IResumeTransferOperationRequest | null | undefined, {} | null | undefined>): void;

resumeTransferOperation(request, callback)

resumeTransferOperation(request: protos.google.storagetransfer.v1.IResumeTransferOperationRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.storagetransfer.v1.IResumeTransferOperationRequest | null | undefined, {} | null | undefined>): void;

runTransferJob(request, options)

runTransferJob(request?: protos.google.storagetransfer.v1.IRunTransferJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.storagetransfer.v1.ITransferOperation>,
        protos.google.longrunning.IOperation | 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.
   */
  /**
   *  Required. The name of the transfer job.
   */
  // const jobName = 'abc123'
  /**
   *  Required. The ID of the Google Cloud project that owns the transfer
   *  job.
   */
  // const projectId = 'abc123'

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

  async function callRunTransferJob() {
    // Construct request
    const request = {
      jobName,
      projectId,
    };

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

  callRunTransferJob();

runTransferJob(request, options, callback)

runTransferJob(request: protos.google.storagetransfer.v1.IRunTransferJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.storagetransfer.v1.ITransferOperation>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

runTransferJob(request, callback)

runTransferJob(request: protos.google.storagetransfer.v1.IRunTransferJobRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.storagetransfer.v1.ITransferOperation>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

updateAgentPool(request, options)

updateAgentPool(request?: protos.google.storagetransfer.v1.IUpdateAgentPoolRequest, options?: CallOptions): Promise<[
        protos.google.storagetransfer.v1.IAgentPool,
        protos.google.storagetransfer.v1.IUpdateAgentPoolRequest | 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.
   */
  /**
   *  Required. The agent pool to update. `agent_pool` is expected to specify
   *  following fields:
   *  *  name google.storagetransfer.v1.AgentPool.name 
   *  *  display_name google.storagetransfer.v1.AgentPool.display_name 
   *  *  bandwidth_limit google.storagetransfer.v1.AgentPool.bandwidth_limit 
   *  An `UpdateAgentPoolRequest` with any other fields is rejected
   *  with the error INVALID_ARGUMENT google.rpc.Code.INVALID_ARGUMENT.
   */
  // const agentPool = {}
  /**
   *  The field mask 
   *  (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf)
   *  of the fields in `agentPool` to update in this request.
   *  The following `agentPool` fields can be updated:
   *  *  display_name google.storagetransfer.v1.AgentPool.display_name 
   *  *  bandwidth_limit google.storagetransfer.v1.AgentPool.bandwidth_limit 
   */
  // const updateMask = {}

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

  async function callUpdateAgentPool() {
    // Construct request
    const request = {
      agentPool,
    };

    // Run request
    const response = await storagetransferClient.updateAgentPool(request);
    console.log(response);
  }

  callUpdateAgentPool();

updateAgentPool(request, options, callback)

updateAgentPool(request: protos.google.storagetransfer.v1.IUpdateAgentPoolRequest, options: CallOptions, callback: Callback<protos.google.storagetransfer.v1.IAgentPool, protos.google.storagetransfer.v1.IUpdateAgentPoolRequest | null | undefined, {} | null | undefined>): void;

updateAgentPool(request, callback)

updateAgentPool(request: protos.google.storagetransfer.v1.IUpdateAgentPoolRequest, callback: Callback<protos.google.storagetransfer.v1.IAgentPool, protos.google.storagetransfer.v1.IUpdateAgentPoolRequest | null | undefined, {} | null | undefined>): void;

updateTransferJob(request, options)

updateTransferJob(request?: protos.google.storagetransfer.v1.IUpdateTransferJobRequest, options?: CallOptions): Promise<[
        protos.google.storagetransfer.v1.ITransferJob,
        protos.google.storagetransfer.v1.IUpdateTransferJobRequest | 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.
   */
  /**
   *  Required. The name of job to update.
   */
  // const jobName = 'abc123'
  /**
   *  Required. The ID of the Google Cloud project that owns the
   *  job.
   */
  // const projectId = 'abc123'
  /**
   *  Required. The job to update. `transferJob` is expected to specify one or
   *  more of five fields:
   *  description google.storagetransfer.v1.TransferJob.description,
   *  transfer_spec google.storagetransfer.v1.TransferJob.transfer_spec,
   *  notification_config google.storagetransfer.v1.TransferJob.notification_config,
   *  logging_config google.storagetransfer.v1.TransferJob.logging_config, and
   *  status google.storagetransfer.v1.TransferJob.status.  An
   *  `UpdateTransferJobRequest` that specifies other fields are rejected with
   *  the error INVALID_ARGUMENT google.rpc.Code.INVALID_ARGUMENT. Updating a
   *  job status to
   *  DELETED google.storagetransfer.v1.TransferJob.Status.DELETED  requires
   *  `storagetransfer.jobs.delete` permission.
   */
  // const transferJob = {}
  /**
   *  The field mask of the fields in `transferJob` that are to be updated in
   *  this request.  Fields in `transferJob` that can be updated are:
   *  description google.storagetransfer.v1.TransferJob.description,
   *  transfer_spec google.storagetransfer.v1.TransferJob.transfer_spec,
   *  notification_config google.storagetransfer.v1.TransferJob.notification_config,
   *  logging_config google.storagetransfer.v1.TransferJob.logging_config, and
   *  status google.storagetransfer.v1.TransferJob.status.  To update the
   *  `transfer_spec` of the job, a complete transfer specification must be
   *  provided. An incomplete specification missing any required fields is
   *  rejected with the error
   *  INVALID_ARGUMENT google.rpc.Code.INVALID_ARGUMENT.
   */
  // const updateTransferJobFieldMask = {}

  // Imports the Storagetransfer library
  const {StorageTransferServiceClient} = require('@google-cloud/storage-transfer').v1;

  // Instantiates a client
  const storagetransferClient = new StorageTransferServiceClient();

  async function callUpdateTransferJob() {
    // Construct request
    const request = {
      jobName,
      projectId,
      transferJob,
    };

    // Run request
    const response = await storagetransferClient.updateTransferJob(request);
    console.log(response);
  }

  callUpdateTransferJob();

updateTransferJob(request, options, callback)

updateTransferJob(request: protos.google.storagetransfer.v1.IUpdateTransferJobRequest, options: CallOptions, callback: Callback<protos.google.storagetransfer.v1.ITransferJob, protos.google.storagetransfer.v1.IUpdateTransferJobRequest | null | undefined, {} | null | undefined>): void;

updateTransferJob(request, callback)

updateTransferJob(request: protos.google.storagetransfer.v1.IUpdateTransferJobRequest, callback: Callback<protos.google.storagetransfer.v1.ITransferJob, protos.google.storagetransfer.v1.IUpdateTransferJobRequest | null | undefined, {} | null | undefined>): void;