mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-30 05:43:43 +01:00
55 lines
24 KiB
HTML
55 lines
24 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_cloudfunctions1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_cloudfunctions1::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_cloudfunctions1/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_cloudfunctions1</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_cloudfunctions1</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_cloudfunctions1/api.rs.html#1-5127" 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.AuditConfig.html" title="google_cloudfunctions1::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_cloudfunctions1::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_cloudfunctions1::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.CallFunctionRequest.html" title="google_cloudfunctions1::api::CallFunctionRequest struct">CallFunctionRequest</a></td><td class="docblock-short"><p>Request for the <code>CallFunction</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CallFunctionResponse.html" title="google_cloudfunctions1::api::CallFunctionResponse struct">CallFunctionResponse</a></td><td class="docblock-short"><p>Response of <code>CallFunction</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CloudFunction.html" title="google_cloudfunctions1::api::CloudFunction struct">CloudFunction</a></td><td class="docblock-short"><p>Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CloudFunctions.html" title="google_cloudfunctions1::api::CloudFunctions struct">CloudFunctions</a></td><td class="docblock-short"><p>Central instance to access all CloudFunctions related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EventTrigger.html" title="google_cloudfunctions1::api::EventTrigger struct">EventTrigger</a></td><td class="docblock-short"><p>Describes EventTrigger, used to request events be sent from another service.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Expr.html" title="google_cloudfunctions1::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.FailurePolicy.html" title="google_cloudfunctions1::api::FailurePolicy struct">FailurePolicy</a></td><td class="docblock-short"><p>Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GenerateDownloadUrlRequest.html" title="google_cloudfunctions1::api::GenerateDownloadUrlRequest struct">GenerateDownloadUrlRequest</a></td><td class="docblock-short"><p>Request of <code>GenerateDownloadUrl</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GenerateDownloadUrlResponse.html" title="google_cloudfunctions1::api::GenerateDownloadUrlResponse struct">GenerateDownloadUrlResponse</a></td><td class="docblock-short"><p>Response of <code>GenerateDownloadUrl</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GenerateUploadUrlRequest.html" title="google_cloudfunctions1::api::GenerateUploadUrlRequest struct">GenerateUploadUrlRequest</a></td><td class="docblock-short"><p>Request of <code>GenerateSourceUploadUrl</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GenerateUploadUrlResponse.html" title="google_cloudfunctions1::api::GenerateUploadUrlResponse struct">GenerateUploadUrlResponse</a></td><td class="docblock-short"><p>Response of <code>GenerateSourceUploadUrl</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.HttpsTrigger.html" title="google_cloudfunctions1::api::HttpsTrigger struct">HttpsTrigger</a></td><td class="docblock-short"><p>Describes HttpsTrigger, could be used to connect web hooks to function.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListFunctionsResponse.html" title="google_cloudfunctions1::api::ListFunctionsResponse struct">ListFunctionsResponse</a></td><td class="docblock-short"><p>Response for the <code>ListFunctions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListLocationsResponse.html" title="google_cloudfunctions1::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_cloudfunctions1::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_cloudfunctions1::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.Operation.html" title="google_cloudfunctions1::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.OperationGetCall.html" title="google_cloudfunctions1::api::OperationGetCall struct">OperationGetCall</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.OperationListCall.html" title="google_cloudfunctions1::api::OperationListCall struct">OperationListCall</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.OperationMethods.html" title="google_cloudfunctions1::api::OperationMethods struct">OperationMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>operation</em> resources.
|
||
It is not used directly, but through the <code>CloudFunctions</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Policy.html" title="google_cloudfunctions1::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.ProjectLocationFunctionCallCall.html" title="google_cloudfunctions1::api::ProjectLocationFunctionCallCall struct">ProjectLocationFunctionCallCall</a></td><td class="docblock-short"><p>Synchronously invokes a deployed Cloud Function. To be used for testing purposes as very limited traffic is allowed. For more information on the actual limits, refer to <a href="https://cloud.google.com/functions/quotas#rate_limits">Rate Limits</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationFunctionCreateCall.html" title="google_cloudfunctions1::api::ProjectLocationFunctionCreateCall struct">ProjectLocationFunctionCreateCall</a></td><td class="docblock-short"><p>Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return <code>ALREADY_EXISTS</code> error.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationFunctionDeleteCall.html" title="google_cloudfunctions1::api::ProjectLocationFunctionDeleteCall struct">ProjectLocationFunctionDeleteCall</a></td><td class="docblock-short"><p>Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationFunctionGenerateDownloadUrlCall.html" title="google_cloudfunctions1::api::ProjectLocationFunctionGenerateDownloadUrlCall struct">ProjectLocationFunctionGenerateDownloadUrlCall</a></td><td class="docblock-short"><p>Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within minutes after generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationFunctionGenerateUploadUrlCall.html" title="google_cloudfunctions1::api::ProjectLocationFunctionGenerateUploadUrlCall struct">ProjectLocationFunctionGenerateUploadUrlCall</a></td><td class="docblock-short"><p>Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 100MB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * <code>content-type: application/zip</code> * <code>x-goog-content-length-range: 0,104857600</code> And this header SHOULD NOT be specified: * <code>Authorization: Bearer YOUR_TOKEN</code></p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationFunctionGetCall.html" title="google_cloudfunctions1::api::ProjectLocationFunctionGetCall struct">ProjectLocationFunctionGetCall</a></td><td class="docblock-short"><p>Returns a function with the given name from the requested project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationFunctionGetIamPolicyCall.html" title="google_cloudfunctions1::api::ProjectLocationFunctionGetIamPolicyCall struct">ProjectLocationFunctionGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the IAM access control policy for a function. Returns an empty policy if the function exists and does not have a policy set.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationFunctionListCall.html" title="google_cloudfunctions1::api::ProjectLocationFunctionListCall struct">ProjectLocationFunctionListCall</a></td><td class="docblock-short"><p>Returns a list of functions that belong to the requested project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationFunctionPatchCall.html" title="google_cloudfunctions1::api::ProjectLocationFunctionPatchCall struct">ProjectLocationFunctionPatchCall</a></td><td class="docblock-short"><p>Updates existing function.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationFunctionSetIamPolicyCall.html" title="google_cloudfunctions1::api::ProjectLocationFunctionSetIamPolicyCall struct">ProjectLocationFunctionSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the IAM access control policy on the specified function. Replaces any existing policy.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationFunctionTestIamPermissionCall.html" title="google_cloudfunctions1::api::ProjectLocationFunctionTestIamPermissionCall struct">ProjectLocationFunctionTestIamPermissionCall</a></td><td class="docblock-short"><p>Tests the specified permissions against the IAM access control policy for a function. If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationListCall.html" title="google_cloudfunctions1::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.ProjectMethods.html" title="google_cloudfunctions1::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>CloudFunctions</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Retry.html" title="google_cloudfunctions1::api::Retry struct">Retry</a></td><td class="docblock-short"><p>Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff (capped at 10 seconds). Retried execution is charged as any other execution.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetIamPolicyRequest.html" title="google_cloudfunctions1::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.SourceRepository.html" title="google_cloudfunctions1::api::SourceRepository struct">SourceRepository</a></td><td class="docblock-short"><p>Describes SourceRepository, used to represent parameters related to source repository where a function is hosted.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Status.html" title="google_cloudfunctions1::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_cloudfunctions1::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_cloudfunctions1::api::TestIamPermissionsResponse struct">TestIamPermissionsResponse</a></td><td class="docblock-short"><p>Response message for <code>TestIamPermissions</code> method.</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_cloudfunctions1::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_cloudfunctions1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |