@alis-build/common-es 1.0.3

package/google/api/apikeys/v2/apikeys_connect.js

@@ -0,0 +1,151 @@
+// Copyright 2022 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.
+
+// @generated by protoc-gen-connect-es v1.7.0 with parameter "target=js+dts"
+// @generated from file google/api/apikeys/v2/apikeys.proto (package google.api.apikeys.v2, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { CreateKeyRequest, DeleteKeyRequest, GetKeyRequest, GetKeyStringRequest, GetKeyStringResponse, ListKeysRequest, ListKeysResponse, LookupKeyRequest, LookupKeyResponse, UndeleteKeyRequest, UpdateKeyRequest } from "./apikeys_pb.js";
+import { Operation } from "../../../longrunning/operations_pb.js";
+import { MethodKind } from "@bufbuild/protobuf";
+import { Key } from "./resources_pb.js";
+
+/**
+ * Manages the API keys associated with projects.
+ *
+ * @generated from service google.api.apikeys.v2.ApiKeys
+ */
+export const ApiKeys = {
+  typeName: "google.api.apikeys.v2.ApiKeys",
+  methods: {
+    /**
+     * Creates a new API key.
+     *
+     * NOTE: Key is a global resource; hence the only supported value for
+     * location is `global`.
+     *
+     * @generated from rpc google.api.apikeys.v2.ApiKeys.CreateKey
+     */
+    createKey: {
+      name: "CreateKey",
+      I: CreateKeyRequest,
+      O: Operation,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Lists the API keys owned by a project. The key string of the API key
+     * isn't included in the response.
+     *
+     * NOTE: Key is a global resource; hence the only supported value for
+     * location is `global`.
+     *
+     * @generated from rpc google.api.apikeys.v2.ApiKeys.ListKeys
+     */
+    listKeys: {
+      name: "ListKeys",
+      I: ListKeysRequest,
+      O: ListKeysResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Gets the metadata for an API key. The key string of the API key
+     * isn't included in the response.
+     *
+     * NOTE: Key is a global resource; hence the only supported value for
+     * location is `global`.
+     *
+     * @generated from rpc google.api.apikeys.v2.ApiKeys.GetKey
+     */
+    getKey: {
+      name: "GetKey",
+      I: GetKeyRequest,
+      O: Key,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Get the key string for an API key.
+     *
+     * NOTE: Key is a global resource; hence the only supported value for
+     * location is `global`.
+     *
+     * @generated from rpc google.api.apikeys.v2.ApiKeys.GetKeyString
+     */
+    getKeyString: {
+      name: "GetKeyString",
+      I: GetKeyStringRequest,
+      O: GetKeyStringResponse,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Patches the modifiable fields of an API key.
+     * The key string of the API key isn't included in the response.
+     *
+     * NOTE: Key is a global resource; hence the only supported value for
+     * location is `global`.
+     *
+     * @generated from rpc google.api.apikeys.v2.ApiKeys.UpdateKey
+     */
+    updateKey: {
+      name: "UpdateKey",
+      I: UpdateKeyRequest,
+      O: Operation,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Deletes an API key. Deleted key can be retrieved within 30 days of
+     * deletion. Afterward, key will be purged from the project.
+     *
+     * NOTE: Key is a global resource; hence the only supported value for
+     * location is `global`.
+     *
+     * @generated from rpc google.api.apikeys.v2.ApiKeys.DeleteKey
+     */
+    deleteKey: {
+      name: "DeleteKey",
+      I: DeleteKeyRequest,
+      O: Operation,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Undeletes an API key which was deleted within 30 days.
+     *
+     * NOTE: Key is a global resource; hence the only supported value for
+     * location is `global`.
+     *
+     * @generated from rpc google.api.apikeys.v2.ApiKeys.UndeleteKey
+     */
+    undeleteKey: {
+      name: "UndeleteKey",
+      I: UndeleteKeyRequest,
+      O: Operation,
+      kind: MethodKind.Unary,
+    },
+    /**
+     * Find the parent project and resource name of the API
+     * key that matches the key string in the request. If the API key has been
+     * purged, resource name will not be set.
+     * The service account must have the `apikeys.keys.lookup` permission
+     * on the parent project.
+     *
+     * @generated from rpc google.api.apikeys.v2.ApiKeys.LookupKey
+     */
+    lookupKey: {
+      name: "LookupKey",
+      I: LookupKeyRequest,
+      O: LookupKeyResponse,
+      kind: MethodKind.Unary,
+    },
+  }
+};

package/google/api/apikeys/v2/apikeys_pb.d.ts

@@ -0,0 +1,449 @@
+// Copyright 2022 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.
+
+// @generated by protoc-gen-es v2.11.0 with parameter "target=js+dts"
+// @generated from file google/api/apikeys/v2/apikeys.proto (package google.api.apikeys.v2, syntax proto3)
+/* eslint-disable */
+
+import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { Key, KeySchema } from "./resources_pb";
+import type { FieldMask } from "../../../protobuf/field_mask_pb";
+import type { OperationSchema } from "../../../longrunning/operations_pb";
+
+/**
+ * Describes the file google/api/apikeys/v2/apikeys.proto.
+ */
+export declare const file_google_api_apikeys_v2_apikeys: GenFile;
+
+/**
+ * Request message for `CreateKey` method.
+ *
+ * @generated from message google.api.apikeys.v2.CreateKeyRequest
+ */
+export declare type CreateKeyRequest = Message<"google.api.apikeys.v2.CreateKeyRequest"> & {
+  /**
+   * Required. The project in which the API key is created.
+   *
+   * @generated from field: string parent = 1;
+   */
+  parent: string;
+
+  /**
+   * Required. The API key fields to set at creation time.
+   * You can configure only the `display_name`, `restrictions`, and
+   * `annotations` fields.
+   *
+   * @generated from field: google.api.apikeys.v2.Key key = 2;
+   */
+  key?: Key;
+
+  /**
+   * User specified key id (optional). If specified, it will become the final
+   * component of the key resource name.
+   *
+   * The id must be unique within the project, must conform with RFC-1034,
+   * is restricted to lower-cased letters, and has a maximum length of 63
+   * characters. In another word, the id must match the regular
+   * expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.
+   *
+   * The id must NOT be a UUID-like string.
+   *
+   * @generated from field: string key_id = 3;
+   */
+  keyId: string;
+};
+
+/**
+ * Describes the message google.api.apikeys.v2.CreateKeyRequest.
+ * Use `create(CreateKeyRequestSchema)` to create a new message.
+ */
+export declare const CreateKeyRequestSchema: GenMessage<CreateKeyRequest>;
+
+/**
+ * Request message for `ListKeys` method.
+ *
+ * @generated from message google.api.apikeys.v2.ListKeysRequest
+ */
+export declare type ListKeysRequest = Message<"google.api.apikeys.v2.ListKeysRequest"> & {
+  /**
+   * Required. Lists all API keys associated with this project.
+   *
+   * @generated from field: string parent = 1;
+   */
+  parent: string;
+
+  /**
+   * Optional. Specifies the maximum number of results to be returned at a time.
+   *
+   * @generated from field: int32 page_size = 2;
+   */
+  pageSize: number;
+
+  /**
+   * Optional. Requests a specific page of results.
+   *
+   * @generated from field: string page_token = 3;
+   */
+  pageToken: string;
+
+  /**
+   * Optional. Indicate that keys deleted in the past 30 days should also be
+   * returned.
+   *
+   * @generated from field: bool show_deleted = 6;
+   */
+  showDeleted: boolean;
+};
+
+/**
+ * Describes the message google.api.apikeys.v2.ListKeysRequest.
+ * Use `create(ListKeysRequestSchema)` to create a new message.
+ */
+export declare const ListKeysRequestSchema: GenMessage<ListKeysRequest>;
+
+/**
+ * Response message for `ListKeys` method.
+ *
+ * @generated from message google.api.apikeys.v2.ListKeysResponse
+ */
+export declare type ListKeysResponse = Message<"google.api.apikeys.v2.ListKeysResponse"> & {
+  /**
+   * A list of API keys.
+   *
+   * @generated from field: repeated google.api.apikeys.v2.Key keys = 1;
+   */
+  keys: Key[];
+
+  /**
+   * The pagination token for the next page of results.
+   *
+   * @generated from field: string next_page_token = 2;
+   */
+  nextPageToken: string;
+};
+
+/**
+ * Describes the message google.api.apikeys.v2.ListKeysResponse.
+ * Use `create(ListKeysResponseSchema)` to create a new message.
+ */
+export declare const ListKeysResponseSchema: GenMessage<ListKeysResponse>;
+
+/**
+ * Request message for `GetKey` method.
+ *
+ * @generated from message google.api.apikeys.v2.GetKeyRequest
+ */
+export declare type GetKeyRequest = Message<"google.api.apikeys.v2.GetKeyRequest"> & {
+  /**
+   * Required. The resource name of the API key to get.
+   *
+   * @generated from field: string name = 1;
+   */
+  name: string;
+};
+
+/**
+ * Describes the message google.api.apikeys.v2.GetKeyRequest.
+ * Use `create(GetKeyRequestSchema)` to create a new message.
+ */
+export declare const GetKeyRequestSchema: GenMessage<GetKeyRequest>;
+
+/**
+ * Request message for `GetKeyString` method.
+ *
+ * @generated from message google.api.apikeys.v2.GetKeyStringRequest
+ */
+export declare type GetKeyStringRequest = Message<"google.api.apikeys.v2.GetKeyStringRequest"> & {
+  /**
+   * Required. The resource name of the API key to be retrieved.
+   *
+   * @generated from field: string name = 1;
+   */
+  name: string;
+};
+
+/**
+ * Describes the message google.api.apikeys.v2.GetKeyStringRequest.
+ * Use `create(GetKeyStringRequestSchema)` to create a new message.
+ */
+export declare const GetKeyStringRequestSchema: GenMessage<GetKeyStringRequest>;
+
+/**
+ * Response message for `GetKeyString` method.
+ *
+ * @generated from message google.api.apikeys.v2.GetKeyStringResponse
+ */
+export declare type GetKeyStringResponse = Message<"google.api.apikeys.v2.GetKeyStringResponse"> & {
+  /**
+   * An encrypted and signed value of the key.
+   *
+   * @generated from field: string key_string = 1;
+   */
+  keyString: string;
+};
+
+/**
+ * Describes the message google.api.apikeys.v2.GetKeyStringResponse.
+ * Use `create(GetKeyStringResponseSchema)` to create a new message.
+ */
+export declare const GetKeyStringResponseSchema: GenMessage<GetKeyStringResponse>;
+
+/**
+ * Request message for `UpdateKey` method.
+ *
+ * @generated from message google.api.apikeys.v2.UpdateKeyRequest
+ */
+export declare type UpdateKeyRequest = Message<"google.api.apikeys.v2.UpdateKeyRequest"> & {
+  /**
+   * Required. Set the `name` field to the resource name of the API key to be
+   * updated. You can update only the `display_name`, `restrictions`, and
+   * `annotations` fields.
+   *
+   * @generated from field: google.api.apikeys.v2.Key key = 1;
+   */
+  key?: Key;
+
+  /**
+   * The field mask specifies which fields to be updated as part of this
+   * request. All other fields are ignored.
+   * Mutable fields are: `display_name`, `restrictions`, and `annotations`.
+   * If an update mask is not provided, the service treats it as an implied mask
+   * equivalent to all allowed fields that are set on the wire. If the field
+   * mask has a special value "*", the service treats it equivalent to replace
+   * all allowed mutable fields.
+   *
+   * @generated from field: google.protobuf.FieldMask update_mask = 2;
+   */
+  updateMask?: FieldMask;
+};
+
+/**
+ * Describes the message google.api.apikeys.v2.UpdateKeyRequest.
+ * Use `create(UpdateKeyRequestSchema)` to create a new message.
+ */
+export declare const UpdateKeyRequestSchema: GenMessage<UpdateKeyRequest>;
+
+/**
+ * Request message for `DeleteKey` method.
+ *
+ * @generated from message google.api.apikeys.v2.DeleteKeyRequest
+ */
+export declare type DeleteKeyRequest = Message<"google.api.apikeys.v2.DeleteKeyRequest"> & {
+  /**
+   * Required. The resource name of the API key to be deleted.
+   *
+   * @generated from field: string name = 1;
+   */
+  name: string;
+
+  /**
+   * Optional. The etag known to the client for the expected state of the key.
+   * This is to be used for optimistic concurrency.
+   *
+   * @generated from field: string etag = 2;
+   */
+  etag: string;
+};
+
+/**
+ * Describes the message google.api.apikeys.v2.DeleteKeyRequest.
+ * Use `create(DeleteKeyRequestSchema)` to create a new message.
+ */
+export declare const DeleteKeyRequestSchema: GenMessage<DeleteKeyRequest>;
+
+/**
+ * Request message for `UndeleteKey` method.
+ *
+ * @generated from message google.api.apikeys.v2.UndeleteKeyRequest
+ */
+export declare type UndeleteKeyRequest = Message<"google.api.apikeys.v2.UndeleteKeyRequest"> & {
+  /**
+   * Required. The resource name of the API key to be undeleted.
+   *
+   * @generated from field: string name = 1;
+   */
+  name: string;
+};
+
+/**
+ * Describes the message google.api.apikeys.v2.UndeleteKeyRequest.
+ * Use `create(UndeleteKeyRequestSchema)` to create a new message.
+ */
+export declare const UndeleteKeyRequestSchema: GenMessage<UndeleteKeyRequest>;
+
+/**
+ * Request message for `LookupKey` method.
+ *
+ * @generated from message google.api.apikeys.v2.LookupKeyRequest
+ */
+export declare type LookupKeyRequest = Message<"google.api.apikeys.v2.LookupKeyRequest"> & {
+  /**
+   * Required. Finds the project that owns the key string value.
+   *
+   * @generated from field: string key_string = 1;
+   */
+  keyString: string;
+};
+
+/**
+ * Describes the message google.api.apikeys.v2.LookupKeyRequest.
+ * Use `create(LookupKeyRequestSchema)` to create a new message.
+ */
+export declare const LookupKeyRequestSchema: GenMessage<LookupKeyRequest>;
+
+/**
+ * Response message for `LookupKey` method.
+ *
+ * @generated from message google.api.apikeys.v2.LookupKeyResponse
+ */
+export declare type LookupKeyResponse = Message<"google.api.apikeys.v2.LookupKeyResponse"> & {
+  /**
+   * The project that owns the key with the value specified in the request.
+   *
+   * @generated from field: string parent = 1;
+   */
+  parent: string;
+
+  /**
+   * The resource name of the API key. If the API key has been purged,
+   * resource name is empty.
+   *
+   * @generated from field: string name = 2;
+   */
+  name: string;
+};
+
+/**
+ * Describes the message google.api.apikeys.v2.LookupKeyResponse.
+ * Use `create(LookupKeyResponseSchema)` to create a new message.
+ */
+export declare const LookupKeyResponseSchema: GenMessage<LookupKeyResponse>;
+
+/**
+ * Manages the API keys associated with projects.
+ *
+ * @generated from service google.api.apikeys.v2.ApiKeys
+ */
+export declare const ApiKeys: GenService<{
+  /**
+   * Creates a new API key.
+   *
+   * NOTE: Key is a global resource; hence the only supported value for
+   * location is `global`.
+   *
+   * @generated from rpc google.api.apikeys.v2.ApiKeys.CreateKey
+   */
+  createKey: {
+    methodKind: "unary";
+    input: typeof CreateKeyRequestSchema;
+    output: typeof OperationSchema;
+  },
+  /**
+   * Lists the API keys owned by a project. The key string of the API key
+   * isn't included in the response.
+   *
+   * NOTE: Key is a global resource; hence the only supported value for
+   * location is `global`.
+   *
+   * @generated from rpc google.api.apikeys.v2.ApiKeys.ListKeys
+   */
+  listKeys: {
+    methodKind: "unary";
+    input: typeof ListKeysRequestSchema;
+    output: typeof ListKeysResponseSchema;
+  },
+  /**
+   * Gets the metadata for an API key. The key string of the API key
+   * isn't included in the response.
+   *
+   * NOTE: Key is a global resource; hence the only supported value for
+   * location is `global`.
+   *
+   * @generated from rpc google.api.apikeys.v2.ApiKeys.GetKey
+   */
+  getKey: {
+    methodKind: "unary";
+    input: typeof GetKeyRequestSchema;
+    output: typeof KeySchema;
+  },
+  /**
+   * Get the key string for an API key.
+   *
+   * NOTE: Key is a global resource; hence the only supported value for
+   * location is `global`.
+   *
+   * @generated from rpc google.api.apikeys.v2.ApiKeys.GetKeyString
+   */
+  getKeyString: {
+    methodKind: "unary";
+    input: typeof GetKeyStringRequestSchema;
+    output: typeof GetKeyStringResponseSchema;
+  },
+  /**
+   * Patches the modifiable fields of an API key.
+   * The key string of the API key isn't included in the response.
+   *
+   * NOTE: Key is a global resource; hence the only supported value for
+   * location is `global`.
+   *
+   * @generated from rpc google.api.apikeys.v2.ApiKeys.UpdateKey
+   */
+  updateKey: {
+    methodKind: "unary";
+    input: typeof UpdateKeyRequestSchema;
+    output: typeof OperationSchema;
+  },
+  /**
+   * Deletes an API key. Deleted key can be retrieved within 30 days of
+   * deletion. Afterward, key will be purged from the project.
+   *
+   * NOTE: Key is a global resource; hence the only supported value for
+   * location is `global`.
+   *
+   * @generated from rpc google.api.apikeys.v2.ApiKeys.DeleteKey
+   */
+  deleteKey: {
+    methodKind: "unary";
+    input: typeof DeleteKeyRequestSchema;
+    output: typeof OperationSchema;
+  },
+  /**
+   * Undeletes an API key which was deleted within 30 days.
+   *
+   * NOTE: Key is a global resource; hence the only supported value for
+   * location is `global`.
+   *
+   * @generated from rpc google.api.apikeys.v2.ApiKeys.UndeleteKey
+   */
+  undeleteKey: {
+    methodKind: "unary";
+    input: typeof UndeleteKeyRequestSchema;
+    output: typeof OperationSchema;
+  },
+  /**
+   * Find the parent project and resource name of the API
+   * key that matches the key string in the request. If the API key has been
+   * purged, resource name will not be set.
+   * The service account must have the `apikeys.keys.lookup` permission
+   * on the parent project.
+   *
+   * @generated from rpc google.api.apikeys.v2.ApiKeys.LookupKey
+   */
+  lookupKey: {
+    methodKind: "unary";
+    input: typeof LookupKeyRequestSchema;
+    output: typeof LookupKeyResponseSchema;
+  },
+}>;