// Copyright 2022 Luca Casonato. All rights reserved. MIT license. /** * Cloud Data Fusion API Client for Deno * ===================================== * * Cloud Data Fusion is a fully-managed, cloud native, enterprise data integration service for quickly building and managing data pipelines. It provides a graphical interface to increase time efficiency and reduce complexity, and allows business users, developers, and data scientists to easily and reliably build scalable data integration solutions to cleanse, prepare, blend, transfer and transform data without having to wrestle with infrastructure. * * Docs: https://cloud.google.com/data-fusion/docs * Source: https://googleapis.deno.dev/v1/datafusion:v1.ts */ import { auth, CredentialsClient, GoogleAuth, request } from "/_/base@v1/mod.ts"; export { auth, GoogleAuth }; export type { CredentialsClient }; /** * Cloud Data Fusion is a fully-managed, cloud native, enterprise data * integration service for quickly building and managing data pipelines. It * provides a graphical interface to increase time efficiency and reduce * complexity, and allows business users, developers, and data scientists to * easily and reliably build scalable data integration solutions to cleanse, * prepare, blend, transfer and transform data without having to wrestle with * infrastructure. */ export class DataFusion { #client: CredentialsClient | undefined; #baseUrl: string; constructor(client?: CredentialsClient, baseUrl: string = "https://datafusion.googleapis.com/") { this.#client = client; this.#baseUrl = baseUrl; } /** * Gets information about a location. * * @param name Resource name for the location. */ async projectsLocationsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as Location; } /** * Creates a new Data Fusion instance in the specified project and location. * * @param parent Required. The instance's project and location in the format projects/{project}/locations/{location}. */ async projectsLocationsInstancesCreate(parent: string, req: Instance, opts: ProjectsLocationsInstancesCreateOptions = {}): Promise { req = serializeInstance(req); const url = new URL(`${this.#baseUrl}v1/${ parent }/instances`); if (opts.instanceId !== undefined) { url.searchParams.append("instanceId", String(opts.instanceId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Deletes a single Date Fusion instance. * * @param name Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance} */ async projectsLocationsInstancesDelete(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * Creates DNS peering on the given resource. * * @param parent Required. The resource on which DNS peering will be created. */ async projectsLocationsInstancesDnsPeeringsCreate(parent: string, req: DnsPeering, opts: ProjectsLocationsInstancesDnsPeeringsCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/dnsPeerings`); if (opts.dnsPeeringId !== undefined) { url.searchParams.append("dnsPeeringId", String(opts.dnsPeeringId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as DnsPeering; } /** * Deletes DNS peering on the given resource. * * @param name Required. The name of the DNS peering zone to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} */ async projectsLocationsInstancesDnsPeeringsDelete(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Empty; } /** * Lists DNS peerings for a given resource. * * @param parent Required. The parent, which owns this collection of dns peerings. Format: projects/{project}/locations/{location}/instances/{instance} */ async projectsLocationsInstancesDnsPeeringsList(parent: string, opts: ProjectsLocationsInstancesDnsPeeringsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/dnsPeerings`); if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListDnsPeeringsResponse; } /** * Gets details of a single Data Fusion instance. * * @param name Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}. */ async projectsLocationsInstancesGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeInstance(data); } /** * Gets the access control policy for a resource. Returns an empty policy if * the resource exists and does not have a policy set. * * @param resource REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsInstancesGetIamPolicy(resource: string, opts: ProjectsLocationsInstancesGetIamPolicyOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ resource }:getIamPolicy`); if (opts["options.requestedPolicyVersion"] !== undefined) { url.searchParams.append("options.requestedPolicyVersion", String(opts["options.requestedPolicyVersion"])); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializePolicy(data); } /** * Lists Data Fusion instances in the specified project and location. * * @param parent Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}. If the location is specified as '-' (wildcard), then all regions available to the project are queried, and the results are aggregated. */ async projectsLocationsInstancesList(parent: string, opts: ProjectsLocationsInstancesListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/instances`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeListInstancesResponse(data); } /** * Updates a single Data Fusion instance. * * @param name Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. */ async projectsLocationsInstancesPatch(name: string, req: Instance, opts: ProjectsLocationsInstancesPatchOptions = {}): Promise { req = serializeInstance(req); opts = serializeProjectsLocationsInstancesPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * Restart a single Data Fusion instance. At the end of an operation instance * is fully restarted. * * @param name Required. Name of the Data Fusion instance which need to be restarted in the form of projects/{project}/locations/{location}/instances/{instance} */ async projectsLocationsInstancesRestart(name: string, req: RestartInstanceRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }:restart`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Sets the access control policy on the specified resource. Replaces any * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and * `PERMISSION_DENIED` errors. * * @param resource REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsInstancesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise { req = serializeSetIamPolicyRequest(req); const url = new URL(`${this.#baseUrl}v1/${ resource }:setIamPolicy`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return deserializePolicy(data); } /** * Returns permissions that a caller has on the specified resource. If the * resource does not exist, this will return an empty set of permissions, not * a `NOT_FOUND` error. Note: This operation is designed to be used for * building permission-aware UIs and command-line tools, not for authorization * checking. This operation may "fail open" without warning. * * @param resource REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsInstancesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ resource }:testIamPermissions`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as TestIamPermissionsResponse; } /** * Lists information about the supported locations for this service. * * @param name The resource that owns the locations collection, if applicable. */ async projectsLocationsList(name: string, opts: ProjectsLocationsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }/locations`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListLocationsResponse; } /** * Starts asynchronous cancellation on a long-running operation. The server * makes a best effort to cancel the operation, but success is not guaranteed. * If the server doesn't support this method, it returns * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or * other methods to check whether the cancellation succeeded or whether the * operation completed despite cancellation. On successful cancellation, the * operation is not deleted; instead, it becomes an operation with an * Operation.error value with a google.rpc.Status.code of 1, corresponding to * `Code.CANCELLED`. * * @param name The name of the operation resource to be cancelled. */ async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }:cancel`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Empty; } /** * Deletes a long-running operation. This method indicates that the client is * no longer interested in the operation result. It does not cancel the * operation. If the server doesn't support this method, it returns * `google.rpc.Code.UNIMPLEMENTED`. * * @param name The name of the operation resource to be deleted. */ async projectsLocationsOperationsDelete(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Empty; } /** * Gets the latest state of a long-running operation. Clients can use this * method to poll the operation result at intervals as recommended by the API * service. * * @param name The name of the operation resource. */ async projectsLocationsOperationsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as Operation; } /** * Lists operations that match the specified filter in the request. If the * server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param name The name of the operation's parent resource. */ async projectsLocationsOperationsList(name: string, opts: ProjectsLocationsOperationsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }/operations`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListOperationsResponse; } /** * Lists possible versions for Data Fusion instances in the specified project * and location. * * @param parent Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}. */ async projectsLocationsVersionsList(parent: string, opts: ProjectsLocationsVersionsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/versions`); if (opts.latestPatchOnly !== undefined) { url.searchParams.append("latestPatchOnly", String(opts.latestPatchOnly)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListAvailableVersionsResponse; } } /** * Identifies Data Fusion accelerators for an instance. */ export interface Accelerator { /** * Optional. The type of an accelator for a Cloud Data Fusion instance. */ acceleratorType?: | "ACCELERATOR_TYPE_UNSPECIFIED" | "CDC" | "HEALTHCARE" | "CCAI_INSIGHTS" | "CLOUDSEARCH"; /** * Output only. The state of the accelerator. */ readonly state?: | "STATE_UNSPECIFIED" | "ENABLED" | "DISABLED" | "UNKNOWN"; } /** * Provides the mapping of a cloud asset to a direct physical location or to a * proxy that defines the location on its behalf. */ export interface AssetLocation { /** * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS * state of the region at the time of asset creation. */ expected?: IsolationExpectations; /** * Defines extra parameters required for specific asset types. */ extraParameters?: ExtraParameter[]; /** * Contains all kinds of physical location definitions for this asset. */ locationData?: LocationData[]; /** * Defines parents assets if any in order to allow later generation of * child_asset_location data via child assets. */ parentAsset?: CloudAsset[]; } /** * Specifies the audit configuration for a service. The configuration * determines which permission types are logged, and what identities, if any, * are exempted from logging. An AuditConfig must have one or more * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a * specific service, the union of the two AuditConfigs is used for that service: * the log_types specified in each AuditConfig are enabled, and the * exempted_members in each AuditLogConfig are exempted. Example Policy with * multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", * "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ * "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": * "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", * "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": * "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For * sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ * logging. It also exempts `jose@example.com` from DATA_READ logging, and * `aliya@example.com` from DATA_WRITE logging. */ export interface AuditConfig { /** * The configuration for logging of each type of permission. */ auditLogConfigs?: AuditLogConfig[]; /** * Specifies a service that will be enabled for audit logging. For example, * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a * special value that covers all services. */ service?: string; } /** * Provides the configuration for logging a type of permissions. Example: { * "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ * "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables * 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from * DATA_READ logging. */ export interface AuditLogConfig { /** * Specifies the identities that do not cause logging for this type of * permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** * The log type that this config enables. */ logType?: | "LOG_TYPE_UNSPECIFIED" | "ADMIN_READ" | "DATA_WRITE" | "DATA_READ"; } /** * Associates `members`, or principals, with a `role`. */ export interface Binding { /** * The condition that is associated with this binding. If the condition * evaluates to `true`, then this binding applies to the current request. If * the condition evaluates to `false`, then this binding does not apply to the * current request. However, a different role binding might grant the same * role to one or more of the principals in this binding. To learn which * resources support conditions in their IAM policies, see the [IAM * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Expr; /** * Specifies the principals requesting access for a Google Cloud resource. * `members` can have the following values: * `allUsers`: A special identifier * that represents anyone who is on the internet; with or without a Google * account. * `allAuthenticatedUsers`: A special identifier that represents * anyone who is authenticated with a Google account or a service account. * Does not include identities that come from external identity providers * (IdPs) through identity federation. * `user:{emailid}`: An email address * that represents a specific Google account. For example, `alice@example.com` * . * `serviceAccount:{emailid}`: An email address that represents a Google * service account. For example, `my-other-app@appspot.gserviceaccount.com`. * * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An * identifier for a [Kubernetes service * account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). * For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * * `group:{emailid}`: An email address that represents a Google group. For * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain * (primary) that represents all the users of that domain. For example, * `google.com` or `example.com`. * * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: * A single identity in a workforce identity pool. * * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: * All workforce identities in a group. * * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: * All workforce identities with a specific attribute value. * * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: * All identities in a workforce identity pool. * * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: * A single identity in a workload identity pool. * * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: * A workload identity pool group. * * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: * All identities in a workload identity pool with a certain attribute. * * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: * All identities in a workload identity pool. * * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique * identifier) representing a user that has been recently deleted. For * example, `alice@example.com?uid=123456789012345678901`. If the user is * recovered, this value reverts to `user:{emailid}` and the recovered user * retains the role in the binding. * * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus * unique identifier) representing a service account that has been recently * deleted. For example, * `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If * the service account is undeleted, this value reverts to * `serviceAccount:{emailid}` and the undeleted service account retains the * role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email * address (plus unique identifier) representing a Google group that has been * recently deleted. For example, * `admins@example.com?uid=123456789012345678901`. If the group is recovered, * this value reverts to `group:{emailid}` and the recovered group retains the * role in the binding. * * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: * Deleted single identity in a workforce identity pool. For example, * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. */ members?: string[]; /** * Role that is assigned to the list of `members`, or principals. For * example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview * of the IAM roles and permissions, see the [IAM * documentation](https://cloud.google.com/iam/docs/roles-overview). For a * list of the available pre-defined roles, see * [here](https://cloud.google.com/iam/docs/understanding-roles). */ role?: string; } /** * Policy ID that identified data placement in Blobstore as per * go/blobstore-user-guide#data-metadata-placement-and-failure-domains */ export interface BlobstoreLocation { policyId?: string[]; } /** * The request message for Operations.CancelOperation. */ export interface CancelOperationRequest { } export interface CloudAsset { assetName?: string; assetType?: string; } export interface CloudAssetComposition { childAsset?: CloudAsset[]; } /** * The crypto key configuration. This field is used by the Customer-managed * encryption keys (CMEK) feature. */ export interface CryptoKeyConfig { /** * The name of the key which is used to encrypt/decrypt customer data. For * key in Cloud KMS, the key should be in the format of * `projects/*\/locations/*\/keyRings/*\/cryptoKeys/*`. */ keyReference?: string; } export interface DirectLocationAssignment { location?: LocationAssignment[]; } /** * DNS peering configuration. These configurations are used to create DNS * peering with the customer Cloud DNS. */ export interface DnsPeering { /** * Optional. Optional description of the dns zone. */ description?: string; /** * Required. The dns name suffix of the zone. */ domain?: string; /** * Required. The resource name of the dns peering zone. Format: * projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} */ name?: string; /** * Optional. Optional target network to which dns peering should happen. */ targetNetwork?: string; /** * Optional. Optional target project to which dns peering should happen. */ targetProject?: 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); } */ export interface Empty { } /** * Confirguration of PubSubEventWriter. */ export interface EventPublishConfig { /** * Required. Option to enable Event Publishing. */ enabled?: boolean; /** * Required. The resource name of the Pub/Sub topic. Format: * projects/{project_id}/topics/{topic_id} */ topic?: string; } /** * Represents a textual expression in the Common Expression Language (CEL) * syntax. CEL is a C-like expression language. The syntax and semantics of CEL * are documented at https://github.com/google/cel-spec. Example (Comparison): * title: "Summary size limit" description: "Determines if a summary is less * than 100 chars" expression: "document.summary.size() < 100" Example * (Equality): title: "Requestor is owner" description: "Determines if requestor * is the document owner" expression: "document.owner == * request.auth.claims.email" Example (Logic): title: "Public documents" * description: "Determine whether the document should be publicly visible" * expression: "document.type != 'private' && document.type != 'internal'" * Example (Data Manipulation): title: "Notification string" description: * "Create a notification string with a timestamp." expression: "'New message * received at ' + string(document.create_time)" The exact variables and * functions that may be referenced within an expression are determined by the * service that evaluates it. See the service documentation for additional * information. */ export interface Expr { /** * Optional. Description of the expression. This is a longer text which * describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** * Textual representation of an expression in Common Expression Language * syntax. */ expression?: string; /** * Optional. String indicating the location of the expression for error * reporting, e.g. a file name and a position in the file. */ location?: string; /** * Optional. Title for the expression, i.e. a short string describing its * purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** * Defines parameters that should only be used for specific asset types. */ export interface ExtraParameter { /** * Details about zones used by regional * compute.googleapis.com/InstanceGroupManager to create instances. */ regionalMigDistributionPolicy?: RegionalMigDistributionPolicy; } /** * Represents a Data Fusion instance. */ export interface Instance { /** * Output only. List of accelerators enabled for this CDF instance. */ readonly accelerators?: Accelerator[]; /** * Output only. Endpoint on which the REST APIs is accessible. */ readonly apiEndpoint?: string; /** * Output only. Available versions that the instance can be upgraded to using * UpdateInstanceRequest. */ readonly availableVersion?: Version[]; /** * Output only. The time the instance was created. */ readonly createTime?: Date; /** * The crypto key configuration. This field is used by the Customer-Managed * Encryption Keys (CMEK) feature. */ cryptoKeyConfig?: CryptoKeyConfig; /** * Optional. Option to enable the Dataplex Lineage Integration feature. */ dataplexDataLineageIntegrationEnabled?: boolean; /** * User-managed service account to set on Dataproc when Cloud Data Fusion * creates Dataproc to run data processing pipelines. This allows users to * have fine-grained access control on Dataproc's accesses to cloud resources. */ dataprocServiceAccount?: string; /** * A description of this instance. */ description?: string; /** * Output only. If the instance state is DISABLED, the reason for disabling * the instance. */ readonly disabledReason?: | "DISABLED_REASON_UNSPECIFIED" | "KMS_KEY_ISSUE"[]; /** * Display name for an instance. */ displayName?: string; /** * Option to enable granular role-based access control. */ enableRbac?: boolean; /** * Option to enable Stackdriver Logging. */ enableStackdriverLogging?: boolean; /** * Option to enable Stackdriver Monitoring. */ enableStackdriverMonitoring?: boolean; /** * Option to enable granular zone separation. */ enableZoneSeparation?: boolean; /** * Option to enable and pass metadata for event publishing. */ eventPublishConfig?: EventPublishConfig; /** * Output only. Cloud Storage bucket generated by Data Fusion in the customer * project. */ readonly gcsBucket?: string; /** * The resource labels for instance to use to annotate any related underlying * resources such as Compute Engine VMs. The character '=' is not allowed to * be used within the labels. */ labels?: { [key: string]: string }; /** * Optional. Configure the maintenance policy for this instance. */ maintenancePolicy?: MaintenancePolicy; /** * Output only. The name of this instance is in the form of * projects/{project}/locations/{location}/instances/{instance}. */ readonly name?: string; /** * Network configuration options. These are required when a private Data * Fusion instance is to be created. */ networkConfig?: NetworkConfig; /** * Map of additional options used to configure the behavior of Data Fusion * instance. */ options?: { [key: string]: string }; /** * Output only. Service agent for the customer project. */ readonly p4ServiceAccount?: string; /** * Optional. Current patch revision of the Data Fusion. */ patchRevision?: string; /** * Specifies whether the Data Fusion instance should be private. If set to * true, all Data Fusion nodes will have private IP addresses and will not be * able to access the public internet. */ privateInstance?: boolean; /** * Output only. Reserved for future use. */ readonly satisfiesPzs?: boolean; /** * Output only. Deprecated. Use tenant_project_id instead to extract the * tenant project ID. */ readonly serviceAccount?: string; /** * Output only. Endpoint on which the Data Fusion UI is accessible. */ readonly serviceEndpoint?: string; /** * Output only. The current state of this Data Fusion instance. */ readonly state?: | "STATE_UNSPECIFIED" | "CREATING" | "ACTIVE" | "FAILED" | "DELETING" | "UPGRADING" | "RESTARTING" | "UPDATING" | "AUTO_UPDATING" | "AUTO_UPGRADING" | "DISABLED"; /** * Output only. Additional information about the current state of this Data * Fusion instance if available. */ readonly stateMessage?: string; /** * Output only. The name of the tenant project. */ readonly tenantProjectId?: string; /** * Required. Instance type. */ type?: | "TYPE_UNSPECIFIED" | "BASIC" | "ENTERPRISE" | "DEVELOPER"; /** * Output only. The time the instance was last updated. */ readonly updateTime?: Date; /** * Current version of the Data Fusion. Only specifiable in Update. */ version?: string; /** * Output only. Endpoint on which the Data Fusion UI is accessible to * third-party users */ readonly workforceIdentityServiceEndpoint?: string; /** * Name of the zone in which the Data Fusion instance will be created. Only * DEVELOPER instances use this field. */ zone?: string; } function serializeInstance(data: any): Instance { return { ...data, maintenancePolicy: data["maintenancePolicy"] !== undefined ? serializeMaintenancePolicy(data["maintenancePolicy"]) : undefined, }; } function deserializeInstance(data: any): Instance { return { ...data, createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined, maintenancePolicy: data["maintenancePolicy"] !== undefined ? deserializeMaintenancePolicy(data["maintenancePolicy"]) : undefined, updateTime: data["updateTime"] !== undefined ? new Date(data["updateTime"]) : undefined, }; } export interface IsolationExpectations { ziOrgPolicy?: | "ZI_UNSPECIFIED" | "ZI_UNKNOWN" | "ZI_NOT_REQUIRED" | "ZI_PREFERRED" | "ZI_REQUIRED"; ziRegionPolicy?: | "ZI_REGION_POLICY_UNSPECIFIED" | "ZI_REGION_POLICY_UNKNOWN" | "ZI_REGION_POLICY_NOT_SET" | "ZI_REGION_POLICY_FAIL_OPEN" | "ZI_REGION_POLICY_FAIL_CLOSED"; ziRegionState?: | "ZI_REGION_UNSPECIFIED" | "ZI_REGION_UNKNOWN" | "ZI_REGION_NOT_ENABLED" | "ZI_REGION_ENABLED"; /** * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state * instead for setting ZI expectations as per * go/zicy-publish-physical-location. */ zoneIsolation?: | "ZI_UNSPECIFIED" | "ZI_UNKNOWN" | "ZI_NOT_REQUIRED" | "ZI_PREFERRED" | "ZI_REQUIRED"; /** * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs * expectations as per go/zicy-publish-physical-location. */ zoneSeparation?: | "ZS_UNSPECIFIED" | "ZS_UNKNOWN" | "ZS_NOT_REQUIRED" | "ZS_REQUIRED"; zsOrgPolicy?: | "ZS_UNSPECIFIED" | "ZS_UNKNOWN" | "ZS_NOT_REQUIRED" | "ZS_REQUIRED"; zsRegionState?: | "ZS_REGION_UNSPECIFIED" | "ZS_REGION_UNKNOWN" | "ZS_REGION_NOT_ENABLED" | "ZS_REGION_ENABLED"; } /** * Response message for the list available versions request. */ export interface ListAvailableVersionsResponse { /** * Represents a list of versions that are supported. */ availableVersions?: Version[]; /** * Token to retrieve the next page of results or empty if there are no more * results in the list. */ nextPageToken?: string; } /** * Response message for list DNS peerings. */ export interface ListDnsPeeringsResponse { /** * List of dns peering. */ dnsPeerings?: DnsPeering[]; /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; } /** * Response message for the list instance request. */ export interface ListInstancesResponse { /** * Represents a list of Data Fusion instances. */ instances?: Instance[]; /** * Token to retrieve the next page of results or empty if there are no more * results in the list. */ nextPageToken?: string; /** * Locations that could not be reached. */ unreachable?: string[]; } function serializeListInstancesResponse(data: any): ListInstancesResponse { return { ...data, instances: data["instances"] !== undefined ? data["instances"].map((item: any) => (serializeInstance(item))) : undefined, }; } function deserializeListInstancesResponse(data: any): ListInstancesResponse { return { ...data, instances: data["instances"] !== undefined ? data["instances"].map((item: any) => (deserializeInstance(item))) : undefined, }; } /** * The response message for Locations.ListLocations. */ export interface ListLocationsResponse { /** * A list of locations that matches the specified filter in the request. */ locations?: Location[]; /** * The standard List next-page token. */ nextPageToken?: string; } /** * The response message for Operations.ListOperations. */ export interface ListOperationsResponse { /** * The standard List next-page token. */ nextPageToken?: string; /** * A list of operations that matches the specified filter in the request. */ operations?: Operation[]; } /** * A resource that represents a Google Cloud location. */ export interface 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; } export interface LocationAssignment { location?: string; locationType?: | "UNSPECIFIED" | "CLUSTER" | "POP" | "CLOUD_ZONE" | "CLOUD_REGION" | "MULTI_REGION_GEO" | "MULTI_REGION_JURISDICTION" | "GLOBAL" | "OTHER"; } export interface LocationData { blobstoreLocation?: BlobstoreLocation; childAssetLocation?: CloudAssetComposition; directLocation?: DirectLocationAssignment; gcpProjectProxy?: TenantProjectProxy; placerLocation?: PlacerLocation; spannerLocation?: SpannerLocation; } /** * Maintenance policy of the instance. */ export interface MaintenancePolicy { /** * Optional. The maintenance exclusion window of the instance. */ maintenanceExclusionWindow?: TimeWindow; /** * Optional. The maintenance window of the instance. */ maintenanceWindow?: MaintenanceWindow; } function serializeMaintenancePolicy(data: any): MaintenancePolicy { return { ...data, maintenanceExclusionWindow: data["maintenanceExclusionWindow"] !== undefined ? serializeTimeWindow(data["maintenanceExclusionWindow"]) : undefined, maintenanceWindow: data["maintenanceWindow"] !== undefined ? serializeMaintenanceWindow(data["maintenanceWindow"]) : undefined, }; } function deserializeMaintenancePolicy(data: any): MaintenancePolicy { return { ...data, maintenanceExclusionWindow: data["maintenanceExclusionWindow"] !== undefined ? deserializeTimeWindow(data["maintenanceExclusionWindow"]) : undefined, maintenanceWindow: data["maintenanceWindow"] !== undefined ? deserializeMaintenanceWindow(data["maintenanceWindow"]) : undefined, }; } /** * Maintenance window of the instance. */ export interface MaintenanceWindow { /** * Required. The recurring time window of the maintenance window. */ recurringTimeWindow?: RecurringTimeWindow; } function serializeMaintenanceWindow(data: any): MaintenanceWindow { return { ...data, recurringTimeWindow: data["recurringTimeWindow"] !== undefined ? serializeRecurringTimeWindow(data["recurringTimeWindow"]) : undefined, }; } function deserializeMaintenanceWindow(data: any): MaintenanceWindow { return { ...data, recurringTimeWindow: data["recurringTimeWindow"] !== undefined ? deserializeRecurringTimeWindow(data["recurringTimeWindow"]) : undefined, }; } /** * Network configuration for a Data Fusion instance. These configurations are * used for peering with the customer network. Configurations are optional when * a public Data Fusion instance is to be created. However, providing these * configurations allows several benefits, such as reduced network latency while * accessing the customer resources from managed Data Fusion instance nodes, as * well as access to the customer on-prem resources. */ export interface NetworkConfig { /** * Optional. Type of connection for establishing private IP connectivity * between the Data Fusion customer project VPC and the corresponding tenant * project from a predefined list of available connection modes. If this field * is unspecified for a private instance, VPC peering is used. */ connectionType?: | "CONNECTION_TYPE_UNSPECIFIED" | "VPC_PEERING" | "PRIVATE_SERVICE_CONNECT_INTERFACES"; /** * Optional. The IP range in CIDR notation to use for the managed Data Fusion * instance nodes. This range must not overlap with any other ranges used in * the Data Fusion instance network. This is required only when using * connection type VPC_PEERING. Format: a.b.c.d/22 Example: 192.168.0.0/22 */ ipAllocation?: string; /** * Optional. Name of the network in the customer project with which the * Tenant Project will be peered for executing pipelines. In case of shared * VPC where the network resides in another host project the network should * specified in the form of * projects/{host-project-id}/global/networks/{network}. This is only required * for connectivity type VPC_PEERING. */ network?: string; /** * Optional. Configuration for Private Service Connect. This is required only * when using connection type PRIVATE_SERVICE_CONNECT_INTERFACES. */ privateServiceConnectConfig?: PrivateServiceConnectConfig; } /** * This resource represents a long-running operation that is the result of a * network API call. */ export interface Operation { /** * If the value is `false`, it means the operation is still in progress. If * `true`, the operation is completed, and either `error` or `response` is * available. */ done?: boolean; /** * The error result of the operation in case of failure or cancellation. */ error?: Status; /** * Service-specific metadata associated with the operation. It typically * contains progress information and common metadata such as create time. Some * services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ metadata?: { [key: string]: any }; /** * The server-assigned name, which is only unique within the same service * that originally returns it. If you use the default HTTP mapping, the `name` * should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** * The normal, successful response of the operation. If the original method * returns no data on success, such as `Delete`, the response is * `google.protobuf.Empty`. If the original method is standard * `Get`/`Create`/`Update`, the response should be the resource. For other * methods, the response should have the type `XxxResponse`, where `Xxx` is * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: { [key: string]: any }; } /** * Represents the metadata of a long-running operation. */ export interface OperationMetadata { /** * Map to hold any additional status info for the operation If there is an * accelerator being enabled/disabled/deleted, this will be populated with * accelerator name as key and status as ENABLING, DISABLING or DELETING */ additionalStatus?: { [key: string]: string }; /** * API version used to start the operation. */ apiVersion?: string; /** * The time the operation was created. */ createTime?: Date; /** * The time the operation finished running. */ endTime?: Date; /** * Identifies whether the user has requested cancellation of the operation. * Operations that have successfully been cancelled have Operation.error value * with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ requestedCancellation?: boolean; /** * Human-readable status of the operation if any. */ statusDetail?: string; /** * Server-defined resource path for the target of the operation. */ target?: string; /** * Name of the verb executed by the operation. */ verb?: string; } function serializeOperationMetadata(data: any): OperationMetadata { return { ...data, createTime: data["createTime"] !== undefined ? data["createTime"].toISOString() : undefined, endTime: data["endTime"] !== undefined ? data["endTime"].toISOString() : undefined, }; } function deserializeOperationMetadata(data: any): OperationMetadata { return { ...data, createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined, endTime: data["endTime"] !== undefined ? new Date(data["endTime"]) : undefined, }; } /** * Message describing that the location of the customer resource is tied to * placer allocations */ export interface PlacerLocation { /** * Directory with a config related to it in placer (e.g. * "/placer/prod/home/my-root/my-dir") */ placerConfig?: string; } /** * An Identity and Access Management (IAM) policy, which specifies access * controls for Google Cloud resources. A `Policy` is a collection of * `bindings`. A `binding` binds one or more `members`, or principals, to a * single `role`. Principals can be user accounts, service accounts, Google * groups, and domains (such as G Suite). A `role` is a named list of * permissions; each `role` can be an IAM predefined role or a user-created * custom role. For some types of Google Cloud resources, a `binding` can also * specify a `condition`, which is a logical expression that allows access to a * resource only if the expression evaluates to `true`. A condition can add * constraints based on attributes of the request, the resource, or both. To * learn which resources support conditions in their IAM policies, see the [IAM * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * **JSON example:** ``` { "bindings": [ { "role": * "roles/resourcemanager.organizationAdmin", "members": [ * "user:mike@example.com", "group:admins@example.com", "domain:google.com", * "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": * "roles/resourcemanager.organizationViewer", "members": [ * "user:eve@example.com" ], "condition": { "title": "expirable access", * "description": "Does not grant access after Sep 2020", "expression": * "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": * "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: * - user:mike@example.com - group:admins@example.com - domain:google.com - * serviceAccount:my-project-id@appspot.gserviceaccount.com role: * roles/resourcemanager.organizationAdmin - members: - user:eve@example.com * role: roles/resourcemanager.organizationViewer condition: title: expirable * access description: Does not grant access after Sep 2020 expression: * request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= * version: 3 ``` For a description of IAM and its features, see the [IAM * documentation](https://cloud.google.com/iam/docs/). */ export interface Policy { /** * Specifies cloud audit logging configuration for this policy. */ auditConfigs?: AuditConfig[]; /** * Associates a list of `members`, or principals, with a `role`. Optionally, * may specify a `condition` that determines how and when the `bindings` are * applied. Each of the `bindings` must contain at least one principal. The * `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of * these principals can be Google groups. Each occurrence of a principal * counts towards these limits. For example, if the `bindings` grant 50 * different roles to `user:alice@example.com`, and not to any other * principal, then you can add another 1,450 principals to the `bindings` in * the `Policy`. */ bindings?: Binding[]; /** * `etag` is used for optimistic concurrency control as a way to help prevent * simultaneous updates of a policy from overwriting each other. It is * strongly suggested that systems make use of the `etag` in the * read-modify-write cycle to perform policy updates in order to avoid race * conditions: An `etag` is returned in the response to `getIamPolicy`, and * systems are expected to put that etag in the request to `setIamPolicy` to * ensure that their change will be applied to the same version of the policy. * **Important:** If you use IAM Conditions, you must include the `etag` field * whenever you call `setIamPolicy`. If you omit this field, then IAM allows * you to overwrite a version `3` policy with a version `1` policy, and all of * the conditions in the version `3` policy are lost. */ etag?: Uint8Array; /** * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. * Requests that specify an invalid value are rejected. Any operation that * affects conditional role bindings must specify version `3`. This * requirement applies to the following operations: * Getting a policy that * includes a conditional role binding * Adding a conditional role binding to * a policy * Changing a conditional role binding in a policy * Removing any * role binding, with or without a condition, from a policy that includes * conditions **Important:** If you use IAM Conditions, you must include the * `etag` field whenever you call `setIamPolicy`. If you omit this field, then * IAM allows you to overwrite a version `3` policy with a version `1` policy, * and all of the conditions in the version `3` policy are lost. If a policy * does not include any conditions, operations on that policy may specify any * valid version or leave the field unset. To learn which resources support * conditions in their IAM policies, see the [IAM * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number; } function serializePolicy(data: any): Policy { return { ...data, etag: data["etag"] !== undefined ? encodeBase64(data["etag"]) : undefined, }; } function deserializePolicy(data: any): Policy { return { ...data, etag: data["etag"] !== undefined ? decodeBase64(data["etag"] as string) : undefined, }; } /** * Configuration for using Private Service Connect to establish connectivity * between the Data Fusion consumer project and the corresponding tenant * project. */ export interface PrivateServiceConnectConfig { /** * Output only. The CIDR block to which the CDF instance can't route traffic * to in the consumer project VPC. The size of this block is /25. The format * of this field is governed by RFC 4632. Example: 240.0.0.0/25 */ readonly effectiveUnreachableCidrBlock?: string; /** * Required. The reference to the network attachment used to establish * private connectivity. It will be of the form * projects/{project-id}/regions/{region}/networkAttachments/{network-attachment-id}. */ networkAttachment?: string; /** * Optional. Input only. The CIDR block to which the CDF instance can't route * traffic to in the consumer project VPC. The size of this block should be at * least /25. This range should not overlap with the primary address range of * any subnetwork used by the network attachment. This range can be used for * other purposes in the consumer VPC as long as there is no requirement for * CDF to reach destinations using these addresses. If this value is not * provided, the server chooses a non RFC 1918 address range. The format of * this field is governed by RFC 4632. Example: 192.168.0.0/25 */ unreachableCidrBlock?: string; } /** * Additional options for DataFusion#projectsLocationsInstancesCreate. */ export interface ProjectsLocationsInstancesCreateOptions { /** * Required. The name of the instance to create. Instance name can only * contain lowercase alphanumeric characters and hyphens. It must start with a * letter and must not end with a hyphen. It can have a maximum of 30 * characters. */ instanceId?: string; } /** * Additional options for * DataFusion#projectsLocationsInstancesDnsPeeringsCreate. */ export interface ProjectsLocationsInstancesDnsPeeringsCreateOptions { /** * Required. The name of the peering to create. */ dnsPeeringId?: string; } /** * Additional options for DataFusion#projectsLocationsInstancesDnsPeeringsList. */ export interface ProjectsLocationsInstancesDnsPeeringsListOptions { /** * The maximum number of dns peerings to return. The service may return fewer * than this value. If unspecified, at most 50 dns peerings will be returned. * The maximum value is 200; values above 200 will be coerced to 200. */ pageSize?: number; /** * A page token, received from a previous `ListDnsPeerings` call. Provide * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListDnsPeerings` must match the call that provided the page * token. */ pageToken?: string; } /** * Additional options for DataFusion#projectsLocationsInstancesGetIamPolicy. */ export interface ProjectsLocationsInstancesGetIamPolicyOptions { /** * Optional. The maximum policy version that will be used to format the * policy. Valid values are 0, 1, and 3. Requests specifying an invalid value * will be rejected. Requests for policies with any conditional role bindings * must specify version 3. Policies with no conditional role bindings may * specify any valid value or leave the field unset. The policy in the * response might use the policy version that you specified, or it might use a * lower policy version. For example, if you specify version 3, but the policy * has no conditional role bindings, the response uses version 1. To learn * which resources support conditions in their IAM policies, see the [IAM * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ ["options.requestedPolicyVersion"]?: number; } /** * Additional options for DataFusion#projectsLocationsInstancesList. */ export interface ProjectsLocationsInstancesListOptions { /** * List filter. */ filter?: string; /** * Sort results. Supported values are "name", "name desc", or "" (unsorted). */ orderBy?: string; /** * The maximum number of items to return. */ pageSize?: number; /** * The next_page_token value to use if there are additional results to * retrieve for this list request. */ pageToken?: string; } /** * Additional options for DataFusion#projectsLocationsInstancesPatch. */ export interface ProjectsLocationsInstancesPatchOptions { /** * Field mask is used to specify the fields that the update will overwrite in * an instance resource. The fields specified in the update_mask are relative * to the resource, not the full request. A field will be overwritten if it is * in the mask. If the user does not provide a mask, the label field will be * overwritten. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsInstancesPatchOptions(data: any): ProjectsLocationsInstancesPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsInstancesPatchOptions(data: any): ProjectsLocationsInstancesPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for DataFusion#projectsLocationsList. */ export interface ProjectsLocationsListOptions { /** * A filter to narrow down results to a preferred subset. The filtering * language accepts strings like `"displayName=tokyo"`, and is documented in * more detail in [AIP-160](https://google.aip.dev/160). */ filter?: string; /** * The maximum number of results to return. If not set, the service selects a * default. */ pageSize?: number; /** * A page token received from the `next_page_token` field in the response. * Send that page token to receive the subsequent page. */ pageToken?: string; } /** * Additional options for DataFusion#projectsLocationsOperationsList. */ export interface ProjectsLocationsOperationsListOptions { /** * The standard list filter. */ filter?: string; /** * The standard list page size. */ pageSize?: number; /** * The standard list page token. */ pageToken?: string; } /** * Additional options for DataFusion#projectsLocationsVersionsList. */ export interface ProjectsLocationsVersionsListOptions { /** * Whether or not to return the latest patch of every available minor * version. If true, only the latest patch will be returned. Ex. if allowed * versions is [6.1.1, 6.1.2, 6.2.0] then response will be [6.1.2, 6.2.0] */ latestPatchOnly?: boolean; /** * The maximum number of items to return. */ pageSize?: number; /** * The next_page_token value to use if there are additional results to * retrieve for this list request. */ pageToken?: string; } /** * Represents an arbitrary window of time that recurs. */ export interface RecurringTimeWindow { /** * Required. An RRULE with format * [RFC-5545](https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how * this window reccurs. They go on for the span of time between the start and * end time. The only supported FREQ value is "WEEKLY". To have something * repeat every weekday, use: "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR". This * specifies how frequently the window starts. To have a 9 am - 5 pm UTC-4 * window every weekday, use something like: ``` start time = * 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = * FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` */ recurrence?: string; /** * Required. The window representing the start and end time of recurrences. * This field ignores the date components of the provided timestamps. Only the * time of day and duration between start and end time are relevant. */ window?: TimeWindow; } function serializeRecurringTimeWindow(data: any): RecurringTimeWindow { return { ...data, window: data["window"] !== undefined ? serializeTimeWindow(data["window"]) : undefined, }; } function deserializeRecurringTimeWindow(data: any): RecurringTimeWindow { return { ...data, window: data["window"] !== undefined ? deserializeTimeWindow(data["window"]) : undefined, }; } /** * To be used for specifying the intended distribution of regional * compute.googleapis.com/InstanceGroupManager instances */ export interface RegionalMigDistributionPolicy { /** * The shape in which the group converges around distribution of resources. * Instance of proto2 enum */ targetShape?: number; /** * Cloud zones used by regional MIG to create instances. */ zones?: ZoneConfiguration[]; } /** * Request message for restarting a Data Fusion instance. */ export interface RestartInstanceRequest { } /** * Request message for `SetIamPolicy` method. */ export interface SetIamPolicyRequest { /** * REQUIRED: The complete policy to be applied to the `resource`. The size of * the policy is limited to a few 10s of KB. An empty policy is a valid policy * but certain Google Cloud services (such as Projects) might reject them. */ policy?: Policy; /** * OPTIONAL: A FieldMask specifying which fields of the policy to modify. * Only the fields in the mask will be modified. If no mask is provided, the * following default mask is used: `paths: "bindings, etag"` */ updateMask?: string /* FieldMask */; } function serializeSetIamPolicyRequest(data: any): SetIamPolicyRequest { return { ...data, policy: data["policy"] !== undefined ? serializePolicy(data["policy"]) : undefined, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeSetIamPolicyRequest(data: any): SetIamPolicyRequest { return { ...data, policy: data["policy"] !== undefined ? deserializePolicy(data["policy"]) : undefined, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } export interface SpannerLocation { /** * Set of backups used by the resource with name in the same format as what * is available at http://table/spanner_automon.backup_metadata */ backupName?: string[]; /** * Set of databases used by the resource in format /span// */ dbName?: string[]; } /** * 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). Each `Status` message contains three * pieces of data: error code, error message, and error details. You can find * out more about this error model and how to work with it in the [API Design * Guide](https://cloud.google.com/apis/design/errors). */ export interface 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?: { [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; } export interface TenantProjectProxy { projectNumbers?: string[]; } /** * Request message for `TestIamPermissions` method. */ export interface TestIamPermissionsRequest { /** * The set of permissions to check for the `resource`. Permissions with * wildcards (such as `*` or `storage.*`) are not allowed. For more * information see [IAM * Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } /** * Response message for `TestIamPermissions` method. */ export interface TestIamPermissionsResponse { /** * A subset of `TestPermissionsRequest.permissions` that the caller is * allowed. */ permissions?: string[]; } /** * Represents an arbitrary window of time. */ export interface TimeWindow { /** * Required. The end time of the time window provided in [RFC * 3339](https://www.ietf.org/rfc/rfc3339.txt) format. The end time should * take place after the start time. Example: "2024-01-02T12:04:06-06:00" */ endTime?: Date; /** * Required. The start time of the time window provided in [RFC * 3339](https://www.ietf.org/rfc/rfc3339.txt) format. Example: * "2024-01-01T12:04:06-04:00" */ startTime?: Date; } function serializeTimeWindow(data: any): TimeWindow { return { ...data, endTime: data["endTime"] !== undefined ? data["endTime"].toISOString() : undefined, startTime: data["startTime"] !== undefined ? data["startTime"].toISOString() : undefined, }; } function deserializeTimeWindow(data: any): TimeWindow { return { ...data, endTime: data["endTime"] !== undefined ? new Date(data["endTime"]) : undefined, startTime: data["startTime"] !== undefined ? new Date(data["startTime"]) : undefined, }; } /** * The Data Fusion version. This proto message stores information about certain * Data Fusion version, which is used for Data Fusion version upgrade. */ export interface Version { /** * Represents a list of available feature names for a given version. */ availableFeatures?: string[]; /** * Whether this is currently the default version for Cloud Data Fusion */ defaultVersion?: boolean; /** * Type represents the release availability of the version */ type?: | "TYPE_UNSPECIFIED" | "TYPE_PREVIEW" | "TYPE_GENERAL_AVAILABILITY"; /** * The version number of the Data Fusion instance, such as '6.0.1.0'. */ versionNumber?: string; } export interface ZoneConfiguration { zone?: string; } function decodeBase64(b64: string): Uint8Array { const binString = atob(b64); const size = binString.length; const bytes = new Uint8Array(size); for (let i = 0; i < size; i++) { bytes[i] = binString.charCodeAt(i); } return bytes; } const base64abc = ["A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z","a","b","c","d","e","f","g","h","i","j","k","l","m","n","o","p","q","r","s","t","u","v","w","x","y","z","0","1","2","3","4","5","6","7","8","9","+","/"]; /** * CREDIT: https://gist.github.com/enepomnyaschih/72c423f727d395eeaa09697058238727 * Encodes a given Uint8Array, ArrayBuffer or string into RFC4648 base64 representation * @param data */ function encodeBase64(uint8: Uint8Array): string { let result = "", i; const l = uint8.length; for (i = 2; i < l; i += 3) { result += base64abc[uint8[i - 2] >> 2]; result += base64abc[((uint8[i - 2] & 0x03) << 4) | (uint8[i - 1] >> 4)]; result += base64abc[((uint8[i - 1] & 0x0f) << 2) | (uint8[i] >> 6)]; result += base64abc[uint8[i] & 0x3f]; } if (i === l + 1) { // 1 octet yet to write result += base64abc[uint8[i - 2] >> 2]; result += base64abc[(uint8[i - 2] & 0x03) << 4]; result += "=="; } if (i === l) { // 2 octets yet to write result += base64abc[uint8[i - 2] >> 2]; result += base64abc[((uint8[i - 2] & 0x03) << 4) | (uint8[i - 1] >> 4)]; result += base64abc[(uint8[i - 1] & 0x0f) << 2]; result += "="; } return result; }