mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 12:51:55 +01:00
51 lines
23 KiB
HTML
51 lines
23 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_datafusion1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_datafusion1::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../google_datafusion1/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_datafusion1</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_datafusion1</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/google_datafusion1/api.rs.html#1-5674" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.Accelerator.html" title="google_datafusion1::api::Accelerator struct">Accelerator</a></td><td class="docblock-short"><p>Identifies Data Fusion accelerators for an instance.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AuditConfig.html" title="google_datafusion1::api::AuditConfig struct">AuditConfig</a></td><td class="docblock-short"><p>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 <code>allServices</code> 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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AuditLogConfig.html" title="google_datafusion1::api::AuditLogConfig struct">AuditLogConfig</a></td><td class="docblock-short"><p>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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Binding.html" title="google_datafusion1::api::Binding struct">Binding</a></td><td class="docblock-short"><p>Associates <code>members</code> with a <code>role</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CancelOperationRequest.html" title="google_datafusion1::api::CancelOperationRequest struct">CancelOperationRequest</a></td><td class="docblock-short"><p>The request message for Operations.CancelOperation.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DataFusion.html" title="google_datafusion1::api::DataFusion struct">DataFusion</a></td><td class="docblock-short"><p>Central instance to access all DataFusion related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Empty.html" title="google_datafusion1::api::Empty struct">Empty</a></td><td class="docblock-short"><p>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 <code>Empty</code> is empty JSON object <code>{}</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Expr.html" title="google_datafusion1::api::Expr struct">Expr</a></td><td class="docblock-short"><p>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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Instance.html" title="google_datafusion1::api::Instance struct">Instance</a></td><td class="docblock-short"><p>Represents a Data Fusion instance.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListAvailableVersionsResponse.html" title="google_datafusion1::api::ListAvailableVersionsResponse struct">ListAvailableVersionsResponse</a></td><td class="docblock-short"><p>Response message for the list available versions request.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListInstancesResponse.html" title="google_datafusion1::api::ListInstancesResponse struct">ListInstancesResponse</a></td><td class="docblock-short"><p>Response message for the list instance request.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListLocationsResponse.html" title="google_datafusion1::api::ListLocationsResponse struct">ListLocationsResponse</a></td><td class="docblock-short"><p>The response message for Locations.ListLocations.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListOperationsResponse.html" title="google_datafusion1::api::ListOperationsResponse struct">ListOperationsResponse</a></td><td class="docblock-short"><p>The response message for Operations.ListOperations.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Location.html" title="google_datafusion1::api::Location struct">Location</a></td><td class="docblock-short"><p>A resource that represents Google Cloud Platform location.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.NetworkConfig.html" title="google_datafusion1::api::NetworkConfig struct">NetworkConfig</a></td><td class="docblock-short"><p>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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Operation.html" title="google_datafusion1::api::Operation struct">Operation</a></td><td class="docblock-short"><p>This resource represents a long-running operation that is the result of a network API call.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Policy.html" title="google_datafusion1::api::Policy struct">Policy</a></td><td class="docblock-short"><p>An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A <code>Policy</code> is a collection of <code>bindings</code>. A <code>binding</code> binds one or more <code>members</code> to a single <code>role</code>. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A <code>role</code> is a named list of permissions; each <code>role</code> can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a <code>binding</code> can also specify a <code>condition</code>, which is a logical expression that allows access to a resource only if the expression evaluates to <code>true</code>. 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 <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>. <strong>JSON example:</strong> { "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 } <strong>YAML example:</strong> 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 <a href="https://cloud.google.com/iam/docs/">IAM documentation</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationGetCall.html" title="google_datafusion1::api::ProjectLocationGetCall struct">ProjectLocationGetCall</a></td><td class="docblock-short"><p>Gets information about a location.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceCreateCall.html" title="google_datafusion1::api::ProjectLocationInstanceCreateCall struct">ProjectLocationInstanceCreateCall</a></td><td class="docblock-short"><p>Creates a new Data Fusion instance in the specified project and location.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceDeleteCall.html" title="google_datafusion1::api::ProjectLocationInstanceDeleteCall struct">ProjectLocationInstanceDeleteCall</a></td><td class="docblock-short"><p>Deletes a single Date Fusion instance.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceGetCall.html" title="google_datafusion1::api::ProjectLocationInstanceGetCall struct">ProjectLocationInstanceGetCall</a></td><td class="docblock-short"><p>Gets details of a single Data Fusion instance.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceGetIamPolicyCall.html" title="google_datafusion1::api::ProjectLocationInstanceGetIamPolicyCall struct">ProjectLocationInstanceGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceListCall.html" title="google_datafusion1::api::ProjectLocationInstanceListCall struct">ProjectLocationInstanceListCall</a></td><td class="docblock-short"><p>Lists Data Fusion instances in the specified project and location.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstancePatchCall.html" title="google_datafusion1::api::ProjectLocationInstancePatchCall struct">ProjectLocationInstancePatchCall</a></td><td class="docblock-short"><p>Updates a single Data Fusion instance.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceRestartCall.html" title="google_datafusion1::api::ProjectLocationInstanceRestartCall struct">ProjectLocationInstanceRestartCall</a></td><td class="docblock-short"><p>Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceSetIamPolicyCall.html" title="google_datafusion1::api::ProjectLocationInstanceSetIamPolicyCall struct">ProjectLocationInstanceSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy on the specified resource. Replaces any existing policy. Can return <code>NOT_FOUND</code>, <code>INVALID_ARGUMENT</code>, and <code>PERMISSION_DENIED</code> errors.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceTestIamPermissionCall.html" title="google_datafusion1::api::ProjectLocationInstanceTestIamPermissionCall struct">ProjectLocationInstanceTestIamPermissionCall</a></td><td class="docblock-short"><p>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 <code>NOT_FOUND</code> 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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationListCall.html" title="google_datafusion1::api::ProjectLocationListCall struct">ProjectLocationListCall</a></td><td class="docblock-short"><p>Lists information about the supported locations for this service.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationOperationCancelCall.html" title="google_datafusion1::api::ProjectLocationOperationCancelCall struct">ProjectLocationOperationCancelCall</a></td><td class="docblock-short"><p>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 <code>google.rpc.Code.UNIMPLEMENTED</code>. 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>Code.CANCELLED</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationOperationDeleteCall.html" title="google_datafusion1::api::ProjectLocationOperationDeleteCall struct">ProjectLocationOperationDeleteCall</a></td><td class="docblock-short"><p>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 <code>google.rpc.Code.UNIMPLEMENTED</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationOperationGetCall.html" title="google_datafusion1::api::ProjectLocationOperationGetCall struct">ProjectLocationOperationGetCall</a></td><td class="docblock-short"><p>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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationOperationListCall.html" title="google_datafusion1::api::ProjectLocationOperationListCall struct">ProjectLocationOperationListCall</a></td><td class="docblock-short"><p>Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns <code>UNIMPLEMENTED</code>. NOTE: the <code>name</code> binding allows API services to override the binding to use different resource name schemes, such as <code>users/*/operations</code>. To override the binding, API services can add a binding such as <code>"/v1/{name=users/*}/operations"</code> to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationVersionListCall.html" title="google_datafusion1::api::ProjectLocationVersionListCall struct">ProjectLocationVersionListCall</a></td><td class="docblock-short"><p>Lists possible versions for Data Fusion instances in the specified project and location.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_datafusion1::api::ProjectMethods struct">ProjectMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>project</em> resources.
|
||
It is not used directly, but through the <code>DataFusion</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RestartInstanceRequest.html" title="google_datafusion1::api::RestartInstanceRequest struct">RestartInstanceRequest</a></td><td class="docblock-short"><p>Request message for restarting a Data Fusion instance.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetIamPolicyRequest.html" title="google_datafusion1::api::SetIamPolicyRequest struct">SetIamPolicyRequest</a></td><td class="docblock-short"><p>Request message for <code>SetIamPolicy</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Status.html" title="google_datafusion1::api::Status struct">Status</a></td><td class="docblock-short"><p>The <code>Status</code> type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by <a href="https://github.com/grpc">gRPC</a>. Each <code>Status</code> 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 <a href="https://cloud.google.com/apis/design/errors">API Design Guide</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsRequest.html" title="google_datafusion1::api::TestIamPermissionsRequest struct">TestIamPermissionsRequest</a></td><td class="docblock-short"><p>Request message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsResponse.html" title="google_datafusion1::api::TestIamPermissionsResponse struct">TestIamPermissionsResponse</a></td><td class="docblock-short"><p>Response message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Version.html" title="google_datafusion1::api::Version struct">Version</a></td><td class="docblock-short"><p>The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade.</p>
|
||
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_datafusion1::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
|
||
A scope is needed when requesting an
|
||
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_datafusion1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |