v1beta1.d.ts 51.5 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
/**
 * Copyright 2019 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace cloudscheduler_v1beta1 {
    interface Options extends GlobalOptions {
        version: 'v1beta1';
    }
    interface StandardParameters {
        /**
         * V1 error format.
         */
        '$.xgafv'?: string;
        /**
         * OAuth access token.
         */
        access_token?: string;
        /**
         * Data format for response.
         */
        alt?: string;
        /**
         * JSONP
         */
        callback?: string;
        /**
         * Selector specifying which fields to include in a partial response.
         */
        fields?: string;
        /**
         * API key. Your API key identifies your project and provides you with API
         * access, quota, and reports. Required unless you provide an OAuth 2.0
         * token.
         */
        key?: string;
        /**
         * OAuth 2.0 token for the current user.
         */
        oauth_token?: string;
        /**
         * Returns response with indentations and line breaks.
         */
        prettyPrint?: boolean;
        /**
         * Available to use for quota purposes for server-side applications. Can be
         * any arbitrary string assigned to a user, but should not exceed 40
         * characters.
         */
        quotaUser?: string;
        /**
         * Legacy upload protocol for media (e.g. "media", "multipart").
         */
        uploadType?: string;
        /**
         * Upload protocol for media (e.g. "raw", "multipart").
         */
        upload_protocol?: string;
    }
    /**
     * Cloud Scheduler API
     *
     * Creates and manages jobs run on a regular recurring schedule.
     *
     * @example
     * const {google} = require('googleapis');
     * const cloudscheduler = google.cloudscheduler('v1beta1');
     *
     * @namespace cloudscheduler
     * @type {Function}
     * @version v1beta1
     * @variation v1beta1
     * @param {object=} options Options for Cloudscheduler
     */
    class Cloudscheduler {
        context: APIRequestContext;
        projects: Resource$Projects;
        constructor(options: GlobalOptions, google?: GoogleConfigurable);
    }
    /**
     * App Engine target. The job will be pushed to a job handler by means of an
     * HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job
     * is acknowledged by means of an HTTP response code in the range [200 - 299].
     * Error 503 is considered an App Engine system error instead of an
     * application error. Requests returning error 503 will be retried regardless
     * of retry configuration and not counted against retry counts. Any other
     * response code, or a failure to receive a response before the deadline,
     * constitutes a failed attempt.
     */
    interface Schema$AppEngineHttpTarget {
        /**
         * App Engine Routing setting for the job.
         */
        appEngineRouting?: Schema$AppEngineRouting;
        /**
         * Body.  HTTP request body. A request body is allowed only if the HTTP
         * method is POST or PUT. It will result in invalid argument error to set a
         * body on a job with an incompatible HttpMethod.
         */
        body?: string;
        /**
         * HTTP request headers.  This map contains the header field names and
         * values. Headers can be set when the job is created.  Cloud Scheduler sets
         * some headers to default values:  * `User-Agent`: By default, this header
         * is   `"AppEngine-Google; (+http://code.google.com/appengine)"`.
         * This header can be modified, but Cloud Scheduler will append
         * `"AppEngine-Google; (+http://code.google.com/appengine)"` to
         * the   modified `User-Agent`. * `X-CloudScheduler`: This header will be
         * set to true.  If the job has an body, Cloud Scheduler sets the following
         * headers:  * `Content-Type`: By default, the `Content-Type` header is set
         * to   `"application/octet-stream"`. The default can be
         * overridden by explictly   setting `Content-Type` to a particular media
         * type when the job is   created.   For example, `Content-Type` can be set
         * to `"application/json"`. * `Content-Length`: This is computed
         * by Cloud Scheduler. This value is   output only. It cannot be changed.
         * The headers below are output only. They cannot be set or overridden:  *
         * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google
         * internal use only.  In addition, some App Engine headers, which contain
         * job-specific information, are also be sent to the job handler.
         */
        headers?: {
            [key: string]: string;
        };
        /**
         * The HTTP method to use for the request. PATCH and OPTIONS are not
         * permitted.
         */
        httpMethod?: string;
        /**
         * The relative URI.  The relative URL must begin with "/" and
         * must be a valid HTTP relative URL. It can contain a path, query string
         * arguments, and `#` fragments. If the relative URL is empty, then the root
         * path "/" will be used. No spaces are allowed, and the maximum
         * length allowed is 2083 characters.
         */
        relativeUri?: string;
    }
    /**
     * App Engine Routing.  For more information about services, versions, and
     * instances see [An Overview of App
     * Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
     * [Microservices Architecture on Google App
     * Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
     * [App Engine Standard request
     * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
     * and [App Engine Flex request
     * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
     */
    interface Schema$AppEngineRouting {
        /**
         * Output only. The host that the job is sent to.  For more information
         * about how App Engine requests are routed, see
         * [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
         * The host is constructed as:   * `host =
         * [application_domain_name]`</br>   `| [service] + '.' +
         * [application_domain_name]`</br>   `| [version] + '.' +
         * [application_domain_name]`</br>   `| [version_dot_service]+
         * '.' + [application_domain_name]`</br>   `| [instance] +
         * '.' + [application_domain_name]`</br>   `|
         * [instance_dot_service] + '.' +
         * [application_domain_name]`</br>   `| [instance_dot_version] +
         * '.' + [application_domain_name]`</br>   `|
         * [instance_dot_version_dot_service] + '.' +
         * [application_domain_name]`  * `application_domain_name` = The domain name
         * of the app, for   example <app-id>.appspot.com, which is associated
         * with the   job's project ID.  * `service =` service  * `version =`
         * version  * `version_dot_service =`   version `+ '.' +`   service
         * * `instance =` instance  * `instance_dot_service =`   instance `+
         * '.' +`   service  * `instance_dot_version =`   instance `+
         * '.' +`   version  * `instance_dot_version_dot_service =` instance
         * `+ '.' +`   version `+ '.' +`   service   If service is
         * empty, then the job will be sent to the service which is the default
         * service when the job is attempted.  If version is empty, then the job
         * will be sent to the version which is the default version when the job is
         * attempted.  If instance is empty, then the job will be sent to an
         * instance which is available when the job is attempted.  If service,
         * version, or instance is invalid, then the job will be sent to the default
         * version of the default service when the job is attempted.
         */
        host?: string;
        /**
         * App instance.  By default, the job is sent to an instance which is
         * available when the job is attempted.  Requests can only be sent to a
         * specific instance if [manual scaling is used in App Engine
         * Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
         * App Engine Flex does not support instances. For more information, see
         * [App Engine Standard request
         * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
         * and [App Engine Flex request
         * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
         */
        instance?: string;
        /**
         * App service.  By default, the job is sent to the service which is the
         * default service when the job is attempted.
         */
        service?: string;
        /**
         * App version.  By default, the job is sent to the version which is the
         * default version when the job is attempted.
         */
        version?: string;
    }
    /**
     * A generic empty message that you can re-use to avoid defining duplicated
     * empty messages in your APIs. A typical example is to use it as the request
     * or the response type of an API method. For instance:      service Foo { rpc
     * Bar(google.protobuf.Empty) returns (google.protobuf.Empty);     }  The JSON
     * representation for `Empty` is empty JSON object `{}`.
     */
    interface Schema$Empty {
    }
    /**
     * Http target. The job will be pushed to the job handler by means of an HTTP
     * request via an http_method such as HTTP POST, HTTP GET, etc. The job is
     * acknowledged by means of an HTTP response code in the range [200 - 299]. A
     * failure to receive a response constitutes a failed execution. For a
     * redirected request, the response returned by the redirected request is
     * considered.
     */
    interface Schema$HttpTarget {
        /**
         * HTTP request body. A request body is allowed only if the HTTP method is
         * POST, PUT, or PATCH. It is an error to set body on a job with an
         * incompatible HttpMethod.
         */
        body?: string;
        /**
         * The user can specify HTTP request headers to send with the job's HTTP
         * request. This map contains the header field names and values. Repeated
         * headers are not supported, but a header value can contain commas. These
         * headers represent a subset of the headers that will accompany the
         * job's HTTP request. Some HTTP request headers will be ignored or
         * replaced. A partial list of headers that will be ignored or replaced is
         * below: - Host: This will be computed by Cloud Scheduler and derived from
         * uri. * `Content-Length`: This will be computed by Cloud Scheduler. *
         * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. *
         * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google
         * internal use only.  The total size of headers must be less than 80KB.
         */
        headers?: {
            [key: string]: string;
        };
        /**
         * Which HTTP method to use for the request.
         */
        httpMethod?: string;
        /**
         * If specified, an [OAuth
         * token](https://developers.google.com/identity/protocols/OAuth2) will be
         * generated and attached as an `Authorization` header in the HTTP request.
         * This type of authorization should be used when sending requests to a GCP
         * endpoint.
         */
        oauthToken?: Schema$OAuthToken;
        /**
         * If specified, an
         * [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
         * token will be generated and attached as an `Authorization` header in the
         * HTTP request.  This type of authorization should be used when sending
         * requests to third party endpoints.
         */
        oidcToken?: Schema$OidcToken;
        /**
         * Required.  The full URI path that the request will be sent to. This
         * string must begin with either "http://" or
         * "https://". Some examples of valid values for uri are:
         * `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will
         * encode some characters for safety and compatibility. The maximum allowed
         * URL length is 2083 characters after encoding.
         */
        uri?: string;
    }
    /**
     * Configuration for a job. The maximum allowed size for a job is 100KB.
     */
    interface Schema$Job {
        /**
         * App Engine HTTP target.
         */
        appEngineHttpTarget?: Schema$AppEngineHttpTarget;
        /**
         * The deadline for job attempts. If the request handler does not respond by
         * this deadline then the request is cancelled and the attempt is marked as
         * a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in
         * execution logs. Cloud Scheduler will retry the job according to the
         * RetryConfig.  The allowed duration for this deadline is:  * For HTTP
         * targets, between 15 seconds and 30 minutes. * For App Engine HTTP
         * targets, between 15   seconds and 24 hours. * For PubSub targets, this
         * field is ignored.
         */
        attemptDeadline?: string;
        /**
         * Optionally caller-specified in CreateJob or UpdateJob.  A human-readable
         * description for the job. This string must not contain more than 500
         * characters.
         */
        description?: string;
        /**
         * HTTP target.
         */
        httpTarget?: Schema$HttpTarget;
        /**
         * Output only. The time the last job attempt started.
         */
        lastAttemptTime?: string;
        /**
         * Optionally caller-specified in CreateJob, after which it becomes output
         * only.  The job name. For example:
         * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.  * `PROJECT_ID`
         * can contain letters ([A-Za-z]), numbers ([0-9]),    hyphens (-), colons
         * (:), or periods (.).    For more information, see    [Identifying
         * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
         * * `LOCATION_ID` is the canonical ID for the job's location.    The
         * list of available locations can be obtained by calling    ListLocations.
         * For more information, see https://cloud.google.com/about/locations/. *
         * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),    hyphens
         * (-), or underscores (_). The maximum length is 500 characters.
         */
        name?: string;
        /**
         * Pub/Sub target.
         */
        pubsubTarget?: Schema$PubsubTarget;
        /**
         * Settings that determine the retry behavior.
         */
        retryConfig?: Schema$RetryConfig;
        /**
         * Required, except when used with UpdateJob.  Describes the schedule on
         * which the job will be executed.  The schedule can be either of the
         * following types:  * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)
         * * English-like
         * [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)
         * As a general rule, execution `n + 1` of a job will not begin until
         * execution `n` has finished. Cloud Scheduler will never allow two
         * simultaneously outstanding executions. For example, this implies that if
         * the `n+1`th execution is scheduled to run at 16:00 but the `n`th
         * execution takes until 16:15, the `n+1`th execution will not start until
         * `16:15`. A scheduled start time will be delayed if the previous execution
         * has not ended when its scheduled time occurs.  If retry_count > 0 and
         * a job attempt fails, the job will be tried a total of retry_count times,
         * with exponential backoff, until the next scheduled start time.
         */
        schedule?: string;
        /**
         * Output only. The next time the job is scheduled. Note that this may be a
         * retry of a previously failed attempt or the next execution time according
         * to the schedule.
         */
        scheduleTime?: string;
        /**
         * Output only. State of the job.
         */
        state?: string;
        /**
         * Output only. The response from the target for the last attempted
         * execution.
         */
        status?: Schema$Status;
        /**
         * Specifies the time zone to be used in interpreting schedule. The value of
         * this field must be a time zone name from the [tz
         * database](http://en.wikipedia.org/wiki/Tz_database).  Note that some time
         * zones include a provision for daylight savings time. The rules for
         * daylight saving time are determined by the chosen tz. For UTC use the
         * string "utc". If a time zone is not specified, the default will
         * be in UTC (also known as GMT).
         */
        timeZone?: string;
        /**
         * Output only. The creation time of the job.
         */
        userUpdateTime?: string;
    }
    /**
     * Response message for listing jobs using ListJobs.
     */
    interface Schema$ListJobsResponse {
        /**
         * The list of jobs.
         */
        jobs?: Schema$Job[];
        /**
         * A token to retrieve next page of results. Pass this value in the
         * page_token field in the subsequent call to ListJobs to retrieve the next
         * page of results. If this is empty it indicates that there are no more
         * results through which to paginate.  The page token is valid for only 2
         * hours.
         */
        nextPageToken?: string;
    }
    /**
     * The response message for Locations.ListLocations.
     */
    interface Schema$ListLocationsResponse {
        /**
         * A list of locations that matches the specified filter in the request.
         */
        locations?: Schema$Location[];
        /**
         * The standard List next-page token.
         */
        nextPageToken?: string;
    }
    /**
     * A resource that represents Google Cloud Platform location.
     */
    interface Schema$Location {
        /**
         * The friendly name for this location, typically a nearby city name. For
         * example, "Tokyo".
         */
        displayName?: string;
        /**
         * Cross-service attributes for the location. For example
         * {"cloud.googleapis.com/region": "us-east1"}
         */
        labels?: {
            [key: string]: string;
        };
        /**
         * The canonical id for this location. For example: `"us-east1"`.
         */
        locationId?: string;
        /**
         * Service-specific metadata. For example the available capacity at the
         * given location.
         */
        metadata?: {
            [key: string]: any;
        };
        /**
         * Resource name for the location, which may vary between implementations.
         * For example: `"projects/example-project/locations/us-east1"`
         */
        name?: string;
    }
    /**
     * Contains information needed for generating an [OAuth
     * token](https://developers.google.com/identity/protocols/OAuth2). This type
     * of authorization should be used when sending requests to a GCP endpoint.
     */
    interface Schema$OAuthToken {
        /**
         * OAuth scope to be used for generating OAuth access token. If not
         * specified, "https://www.googleapis.com/auth/cloud-platform"
         * will be used.
         */
        scope?: string;
        /**
         * [Service account
         * email](https://cloud.google.com/iam/docs/service-accounts) to be used for
         * generating OAuth token. The service account must be within the same
         * project as the job. The caller must have iam.serviceAccounts.actAs
         * permission for the service account.
         */
        serviceAccountEmail?: string;
    }
    /**
     * Contains information needed for generating an [OpenID Connect
     * token](https://developers.google.com/identity/protocols/OpenIDConnect).
     * This type of authorization should be used when sending requests to third
     * party endpoints.
     */
    interface Schema$OidcToken {
        /**
         * Audience to be used when generating OIDC token. If not specified, the URI
         * specified in target will be used.
         */
        audience?: string;
        /**
         * [Service account
         * email](https://cloud.google.com/iam/docs/service-accounts) to be used for
         * generating OIDC token. The service account must be within the same
         * project as the job. The caller must have iam.serviceAccounts.actAs
         * permission for the service account.
         */
        serviceAccountEmail?: string;
    }
    /**
     * Request message for PauseJob.
     */
    interface Schema$PauseJobRequest {
    }
    /**
     * A message that is published by publishers and consumed by subscribers. The
     * message must contain either a non-empty data field or at least one
     * attribute. Note that client libraries represent this object differently
     * depending on the language. See the corresponding <a
     * href="https://cloud.google.com/pubsub/docs/reference/libraries">client
     * library documentation</a> for more information. See <a
     * href="https://cloud.google.com/pubsub/quotas">Quotas and
     * limits</a> for more information about message limits.
     */
    interface Schema$PubsubMessage {
        /**
         * Optional attributes for this message.
         */
        attributes?: {
            [key: string]: string;
        };
        /**
         * The message data field. If this field is empty, the message must contain
         * at least one attribute.
         */
        data?: string;
        /**
         * ID of this message, assigned by the server when the message is published.
         * Guaranteed to be unique within the topic. This value may be read by a
         * subscriber that receives a `PubsubMessage` via a `Pull` call or a push
         * delivery. It must not be populated by the publisher in a `Publish` call.
         */
        messageId?: string;
        /**
         * The time at which the message was published, populated by the server when
         * it receives the `Publish` call. It must not be populated by the publisher
         * in a `Publish` call.
         */
        publishTime?: string;
    }
    /**
     * Pub/Sub target. The job will be delivered by publishing a message to the
     * given Pub/Sub topic.
     */
    interface Schema$PubsubTarget {
        /**
         * Attributes for PubsubMessage.  Pubsub message must contain either
         * non-empty data, or at least one attribute.
         */
        attributes?: {
            [key: string]: string;
        };
        /**
         * The message payload for PubsubMessage.  Pubsub message must contain
         * either non-empty data, or at least one attribute.
         */
        data?: string;
        /**
         * Required.  The name of the Cloud Pub/Sub topic to which messages will be
         * published when a job is delivered. The topic name must be in the same
         * format as required by PubSub's
         * [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),
         * for example `projects/PROJECT_ID/topics/TOPIC_ID`.  The topic must be in
         * the same project as the Cloud Scheduler job.
         */
        topicName?: string;
    }
    /**
     * Request message for ResumeJob.
     */
    interface Schema$ResumeJobRequest {
    }
    /**
     * Settings that determine the retry behavior.  By default, if a job does not
     * complete successfully (meaning that an acknowledgement is not received from
     * the handler, then it will be retried with exponential backoff according to
     * the settings in RetryConfig.
     */
    interface Schema$RetryConfig {
        /**
         * The maximum amount of time to wait before retrying a job after it fails.
         * The default value of this field is 1 hour.
         */
        maxBackoffDuration?: string;
        /**
         * The time between retries will double `max_doublings` times.  A job's
         * retry interval starts at min_backoff_duration, then doubles
         * `max_doublings` times, then increases linearly, and finally retries
         * retries at intervals of max_backoff_duration up to retry_count times. For
         * example, if min_backoff_duration is 10s, max_backoff_duration is 300s,
         * and `max_doublings` is 3, then the a job will first be retried in 10s.
         * The retry interval will double three times, and then increase linearly by
         * 2^3 * 10s.  Finally, the job will retry at intervals of
         * max_backoff_duration until the job has been attempted retry_count times.
         * Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s,
         * 300s, ....  The default value of this field is 5.
         */
        maxDoublings?: number;
        /**
         * The time limit for retrying a failed job, measured from time when an
         * execution was first attempted. If specified with retry_count, the job
         * will be retried until both limits are reached.  The default value for
         * max_retry_duration is zero, which means retry duration is unlimited.
         */
        maxRetryDuration?: string;
        /**
         * The minimum amount of time to wait before retrying a job after it fails.
         * The default value of this field is 5 seconds.
         */
        minBackoffDuration?: string;
        /**
         * The number of attempts that the system will make to run a job using the
         * exponential backoff procedure described by max_doublings.  The default
         * value of retry_count is zero.  If retry_count is zero, a job attempt will
         * *not* be retried if it fails. Instead the Cloud Scheduler system will
         * wait for the next scheduled execution time.  If retry_count is set to a
         * non-zero number then Cloud Scheduler will retry failed attempts, using
         * exponential backoff, retry_count times, or until the next scheduled
         * execution time, whichever comes first.  Values greater than 5 and
         * negative values are not allowed.
         */
        retryCount?: number;
    }
    /**
     * Request message for forcing a job to run now using RunJob.
     */
    interface Schema$RunJobRequest {
    }
    /**
     * The `Status` type defines a logical error model that is suitable for
     * different programming environments, including REST APIs and RPC APIs. It is
     * used by [gRPC](https://github.com/grpc). The error model is designed to be:
     * - Simple to use and understand for most users - Flexible enough to meet
     * unexpected needs  # Overview  The `Status` message contains three pieces of
     * data: error code, error message, and error details. The error code should
     * be an enum value of google.rpc.Code, but it may accept additional error
     * codes if needed.  The error message should be a developer-facing English
     * message that helps developers *understand* and *resolve* the error. If a
     * localized user-facing error message is needed, put the localized message in
     * the error details or localize it in the client. The optional error details
     * may contain arbitrary information about the error. There is a predefined
     * set of error detail types in the package `google.rpc` that can be used for
     * common error conditions.  # Language mapping  The `Status` message is the
     * logical representation of the error model, but it is not necessarily the
     * actual wire format. When the `Status` message is exposed in different
     * client libraries and different wire protocols, it can be mapped
     * differently. For example, it will likely be mapped to some exceptions in
     * Java, but more likely mapped to some error codes in C.  # Other uses  The
     * error model and the `Status` message can be used in a variety of
     * environments, either with or without APIs, to provide a consistent
     * developer experience across different environments.  Example uses of this
     * error model include:  - Partial errors. If a service needs to return
     * partial errors to the client,     it may embed the `Status` in the normal
     * response to indicate the partial     errors.  - Workflow errors. A typical
     * workflow has multiple steps. Each step may     have a `Status` message for
     * error reporting.  - Batch operations. If a client uses batch request and
     * batch response, the     `Status` message should be used directly inside
     * batch response, one for     each error sub-response.  - Asynchronous
     * operations. If an API call embeds asynchronous operation     results in its
     * response, the status of those operations should be     represented directly
     * using the `Status` message.  - Logging. If some API errors are stored in
     * logs, the message `Status` could     be used directly after any stripping
     * needed for security/privacy reasons.
     */
    interface Schema$Status {
        /**
         * The status code, which should be an enum value of google.rpc.Code.
         */
        code?: number;
        /**
         * A list of messages that carry the error details.  There is a common set
         * of message types for APIs to use.
         */
        details?: Array<{
            [key: string]: any;
        }>;
        /**
         * A developer-facing error message, which should be in English. Any
         * user-facing error message should be localized and sent in the
         * google.rpc.Status.details field, or localized by the client.
         */
        message?: string;
    }
    class Resource$Projects {
        context: APIRequestContext;
        locations: Resource$Projects$Locations;
        constructor(context: APIRequestContext);
    }
    class Resource$Projects$Locations {
        context: APIRequestContext;
        jobs: Resource$Projects$Locations$Jobs;
        constructor(context: APIRequestContext);
        /**
         * cloudscheduler.projects.locations.get
         * @desc Gets information about a location.
         * @alias cloudscheduler.projects.locations.get
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.name Resource name for the location.
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        get(params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions): GaxiosPromise<Schema$Location>;
        get(params: Params$Resource$Projects$Locations$Get, options: MethodOptions | BodyResponseCallback<Schema$Location>, callback: BodyResponseCallback<Schema$Location>): void;
        get(params: Params$Resource$Projects$Locations$Get, callback: BodyResponseCallback<Schema$Location>): void;
        get(callback: BodyResponseCallback<Schema$Location>): void;
        /**
         * cloudscheduler.projects.locations.list
         * @desc Lists information about the supported locations for this service.
         * @alias cloudscheduler.projects.locations.list
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string=} params.filter The standard list filter.
         * @param {string} params.name The resource that owns the locations collection, if applicable.
         * @param {integer=} params.pageSize The standard list page size.
         * @param {string=} params.pageToken The standard list page token.
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        list(params?: Params$Resource$Projects$Locations$List, options?: MethodOptions): GaxiosPromise<Schema$ListLocationsResponse>;
        list(params: Params$Resource$Projects$Locations$List, options: MethodOptions | BodyResponseCallback<Schema$ListLocationsResponse>, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
        list(params: Params$Resource$Projects$Locations$List, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
        list(callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
    }
    interface Params$Resource$Projects$Locations$Get extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Resource name for the location.
         */
        name?: string;
    }
    interface Params$Resource$Projects$Locations$List extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * The standard list filter.
         */
        filter?: string;
        /**
         * The resource that owns the locations collection, if applicable.
         */
        name?: string;
        /**
         * The standard list page size.
         */
        pageSize?: number;
        /**
         * The standard list page token.
         */
        pageToken?: string;
    }
    class Resource$Projects$Locations$Jobs {
        context: APIRequestContext;
        constructor(context: APIRequestContext);
        /**
         * cloudscheduler.projects.locations.jobs.create
         * @desc Creates a job.
         * @alias cloudscheduler.projects.locations.jobs.create
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.parent Required.  The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.
         * @param {().Job} params.resource Request body data
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        create(params?: Params$Resource$Projects$Locations$Jobs$Create, options?: MethodOptions): GaxiosPromise<Schema$Job>;
        create(params: Params$Resource$Projects$Locations$Jobs$Create, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
        create(params: Params$Resource$Projects$Locations$Jobs$Create, callback: BodyResponseCallback<Schema$Job>): void;
        create(callback: BodyResponseCallback<Schema$Job>): void;
        /**
         * cloudscheduler.projects.locations.jobs.delete
         * @desc Deletes a job.
         * @alias cloudscheduler.projects.locations.jobs.delete
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.name Required.  The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        delete(params?: Params$Resource$Projects$Locations$Jobs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
        delete(params: Params$Resource$Projects$Locations$Jobs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
        delete(params: Params$Resource$Projects$Locations$Jobs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
        delete(callback: BodyResponseCallback<Schema$Empty>): void;
        /**
         * cloudscheduler.projects.locations.jobs.get
         * @desc Gets a job.
         * @alias cloudscheduler.projects.locations.jobs.get
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.name Required.  The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        get(params?: Params$Resource$Projects$Locations$Jobs$Get, options?: MethodOptions): GaxiosPromise<Schema$Job>;
        get(params: Params$Resource$Projects$Locations$Jobs$Get, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
        get(params: Params$Resource$Projects$Locations$Jobs$Get, callback: BodyResponseCallback<Schema$Job>): void;
        get(callback: BodyResponseCallback<Schema$Job>): void;
        /**
         * cloudscheduler.projects.locations.jobs.list
         * @desc Lists jobs.
         * @alias cloudscheduler.projects.locations.jobs.list
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {integer=} params.pageSize Requested page size.  The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist.
         * @param {string=} params.pageToken A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages.
         * @param {string} params.parent Required.  The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        list(params?: Params$Resource$Projects$Locations$Jobs$List, options?: MethodOptions): GaxiosPromise<Schema$ListJobsResponse>;
        list(params: Params$Resource$Projects$Locations$Jobs$List, options: MethodOptions | BodyResponseCallback<Schema$ListJobsResponse>, callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
        list(params: Params$Resource$Projects$Locations$Jobs$List, callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
        list(callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
        /**
         * cloudscheduler.projects.locations.jobs.patch
         * @desc Updates a job.  If successful, the updated Job is returned. If the
         * job does not exist, `NOT_FOUND` is returned.  If UpdateJob does not
         * successfully return, it is possible for the job to be in an
         * Job.State.UPDATE_FAILED state. A job in this state may not be executed.
         * If this happens, retry the UpdateJob request until a successful response
         * is received.
         * @alias cloudscheduler.projects.locations.jobs.patch
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.name Optionally caller-specified in CreateJob, after which it becomes output only.  The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.  * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),    hyphens (-), colons (:), or periods (.).    For more information, see    [Identifying    projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location.    The list of available locations can be obtained by calling    ListLocations.    For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),    hyphens (-), or underscores (_). The maximum length is 500 characters.
         * @param {string=} params.updateMask A  mask used to specify which fields of the job are being updated.
         * @param {().Job} params.resource Request body data
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        patch(params?: Params$Resource$Projects$Locations$Jobs$Patch, options?: MethodOptions): GaxiosPromise<Schema$Job>;
        patch(params: Params$Resource$Projects$Locations$Jobs$Patch, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
        patch(params: Params$Resource$Projects$Locations$Jobs$Patch, callback: BodyResponseCallback<Schema$Job>): void;
        patch(callback: BodyResponseCallback<Schema$Job>): void;
        /**
         * cloudscheduler.projects.locations.jobs.pause
         * @desc Pauses a job.  If a job is paused then the system will stop
         * executing the job until it is re-enabled via ResumeJob. The state of the
         * job is stored in state; if paused it will be set to Job.State.PAUSED. A
         * job must be in Job.State.ENABLED to be paused.
         * @alias cloudscheduler.projects.locations.jobs.pause
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.name Required.  The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
         * @param {().PauseJobRequest} params.resource Request body data
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        pause(params?: Params$Resource$Projects$Locations$Jobs$Pause, options?: MethodOptions): GaxiosPromise<Schema$Job>;
        pause(params: Params$Resource$Projects$Locations$Jobs$Pause, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
        pause(params: Params$Resource$Projects$Locations$Jobs$Pause, callback: BodyResponseCallback<Schema$Job>): void;
        pause(callback: BodyResponseCallback<Schema$Job>): void;
        /**
         * cloudscheduler.projects.locations.jobs.resume
         * @desc Resume a job.  This method reenables a job after it has been
         * Job.State.PAUSED. The state of a job is stored in Job.state; after
         * calling this method it will be set to Job.State.ENABLED. A job must be in
         * Job.State.PAUSED to be resumed.
         * @alias cloudscheduler.projects.locations.jobs.resume
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.name Required.  The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
         * @param {().ResumeJobRequest} params.resource Request body data
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        resume(params?: Params$Resource$Projects$Locations$Jobs$Resume, options?: MethodOptions): GaxiosPromise<Schema$Job>;
        resume(params: Params$Resource$Projects$Locations$Jobs$Resume, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
        resume(params: Params$Resource$Projects$Locations$Jobs$Resume, callback: BodyResponseCallback<Schema$Job>): void;
        resume(callback: BodyResponseCallback<Schema$Job>): void;
        /**
         * cloudscheduler.projects.locations.jobs.run
         * @desc Forces a job to run now.  When this method is called, Cloud
         * Scheduler will dispatch the job, even if the job is already running.
         * @alias cloudscheduler.projects.locations.jobs.run
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string} params.name Required.  The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
         * @param {().RunJobRequest} params.resource Request body data
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        run(params?: Params$Resource$Projects$Locations$Jobs$Run, options?: MethodOptions): GaxiosPromise<Schema$Job>;
        run(params: Params$Resource$Projects$Locations$Jobs$Run, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
        run(params: Params$Resource$Projects$Locations$Jobs$Run, callback: BodyResponseCallback<Schema$Job>): void;
        run(callback: BodyResponseCallback<Schema$Job>): void;
    }
    interface Params$Resource$Projects$Locations$Jobs$Create extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Required.  The location name. For example:
         * `projects/PROJECT_ID/locations/LOCATION_ID`.
         */
        parent?: string;
        /**
         * Request body metadata
         */
        requestBody?: Schema$Job;
    }
    interface Params$Resource$Projects$Locations$Jobs$Delete extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Required.  The job name. For example:
         * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
         */
        name?: string;
    }
    interface Params$Resource$Projects$Locations$Jobs$Get extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Required.  The job name. For example:
         * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
         */
        name?: string;
    }
    interface Params$Resource$Projects$Locations$Jobs$List extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Requested page size.  The maximum page size is 500. If unspecified, the
         * page size will be the maximum. Fewer jobs than requested might be
         * returned, even if more jobs exist; use next_page_token to determine if
         * more jobs exist.
         */
        pageSize?: number;
        /**
         * A token identifying a page of results the server will return. To request
         * the first page results, page_token must be empty. To request the next
         * page of results, page_token must be the value of next_page_token returned
         * from the previous call to ListJobs. It is an error to switch the value of
         * filter or order_by while iterating through pages.
         */
        pageToken?: string;
        /**
         * Required.  The location name. For example:
         * `projects/PROJECT_ID/locations/LOCATION_ID`.
         */
        parent?: string;
    }
    interface Params$Resource$Projects$Locations$Jobs$Patch extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Optionally caller-specified in CreateJob, after which it becomes output
         * only.  The job name. For example:
         * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.  * `PROJECT_ID`
         * can contain letters ([A-Za-z]), numbers ([0-9]),    hyphens (-), colons
         * (:), or periods (.).    For more information, see    [Identifying
         * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
         * * `LOCATION_ID` is the canonical ID for the job's location.    The list
         * of available locations can be obtained by calling    ListLocations. For
         * more information, see https://cloud.google.com/about/locations/. *
         * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),    hyphens
         * (-), or underscores (_). The maximum length is 500 characters.
         */
        name?: string;
        /**
         * A  mask used to specify which fields of the job are being updated.
         */
        updateMask?: string;
        /**
         * Request body metadata
         */
        requestBody?: Schema$Job;
    }
    interface Params$Resource$Projects$Locations$Jobs$Pause extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Required.  The job name. For example:
         * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
         */
        name?: string;
        /**
         * Request body metadata
         */
        requestBody?: Schema$PauseJobRequest;
    }
    interface Params$Resource$Projects$Locations$Jobs$Resume extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Required.  The job name. For example:
         * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
         */
        name?: string;
        /**
         * Request body metadata
         */
        requestBody?: Schema$ResumeJobRequest;
    }
    interface Params$Resource$Projects$Locations$Jobs$Run extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Required.  The job name. For example:
         * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
         */
        name?: string;
        /**
         * Request body metadata
         */
        requestBody?: Schema$RunJobRequest;
    }
}