mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 20:30:52 +01:00
50 lines
23 KiB
HTML
50 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_binaryauthorization1_beta1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_binaryauthorization1_beta1::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_binaryauthorization1_beta1/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_binaryauthorization1_beta1</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_binaryauthorization1_beta1</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_binaryauthorization1_beta1/api.rs.html#1-5252" 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.AdmissionRule.html" title="google_binaryauthorization1_beta1::api::AdmissionRule struct">AdmissionRule</a></td><td class="docblock-short"><p>An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AdmissionWhitelistPattern.html" title="google_binaryauthorization1_beta1::api::AdmissionWhitelistPattern struct">AdmissionWhitelistPattern</a></td><td class="docblock-short"><p>An admission allowlist pattern exempts images from checks by admission rules.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AttestationOccurrence.html" title="google_binaryauthorization1_beta1::api::AttestationOccurrence struct">AttestationOccurrence</a></td><td class="docblock-short"><p>Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Attestor.html" title="google_binaryauthorization1_beta1::api::Attestor struct">Attestor</a></td><td class="docblock-short"><p>An attestor that attests to container image artifacts. An existing attestor cannot be modified except where indicated.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AttestorPublicKey.html" title="google_binaryauthorization1_beta1::api::AttestorPublicKey struct">AttestorPublicKey</a></td><td class="docblock-short"><p>An attestor public key that will be used to verify attestations signed by this attestor.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BinaryAuthorization.html" title="google_binaryauthorization1_beta1::api::BinaryAuthorization struct">BinaryAuthorization</a></td><td class="docblock-short"><p>Central instance to access all BinaryAuthorization related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Binding.html" title="google_binaryauthorization1_beta1::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.Empty.html" title="google_binaryauthorization1_beta1::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_binaryauthorization1_beta1::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.IamPolicy.html" title="google_binaryauthorization1_beta1::api::IamPolicy struct">IamPolicy</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.Jwt.html" title="google_binaryauthorization1_beta1::api::Jwt struct">Jwt</a></td><td class="docblock-short"><p>There is no detailed description.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListAttestorsResponse.html" title="google_binaryauthorization1_beta1::api::ListAttestorsResponse struct">ListAttestorsResponse</a></td><td class="docblock-short"><p>Response message for BinauthzManagementService.ListAttestors.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PkixPublicKey.html" title="google_binaryauthorization1_beta1::api::PkixPublicKey struct">PkixPublicKey</a></td><td class="docblock-short"><p>A public key in the PkixPublicKey format (see https://tools.ietf.org/html/rfc5280#section-4.1.2.7 for details). Public keys of this type are typically textually encoded using the PEM format.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Policy.html" title="google_binaryauthorization1_beta1::api::Policy struct">Policy</a></td><td class="docblock-short"><p>A policy for container image binary authorization.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectAttestorCreateCall.html" title="google_binaryauthorization1_beta1::api::ProjectAttestorCreateCall struct">ProjectAttestorCreateCall</a></td><td class="docblock-short"><p>Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectAttestorDeleteCall.html" title="google_binaryauthorization1_beta1::api::ProjectAttestorDeleteCall struct">ProjectAttestorDeleteCall</a></td><td class="docblock-short"><p>Deletes an attestor. Returns NOT_FOUND if the attestor does not exist.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectAttestorGetCall.html" title="google_binaryauthorization1_beta1::api::ProjectAttestorGetCall struct">ProjectAttestorGetCall</a></td><td class="docblock-short"><p>Gets an attestor. Returns NOT_FOUND if the attestor does not exist.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectAttestorGetIamPolicyCall.html" title="google_binaryauthorization1_beta1::api::ProjectAttestorGetIamPolicyCall struct">ProjectAttestorGetIamPolicyCall</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.ProjectAttestorListCall.html" title="google_binaryauthorization1_beta1::api::ProjectAttestorListCall struct">ProjectAttestorListCall</a></td><td class="docblock-short"><p>Lists attestors. Returns INVALID_ARGUMENT if the project does not exist.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectAttestorSetIamPolicyCall.html" title="google_binaryauthorization1_beta1::api::ProjectAttestorSetIamPolicyCall struct">ProjectAttestorSetIamPolicyCall</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.ProjectAttestorTestIamPermissionCall.html" title="google_binaryauthorization1_beta1::api::ProjectAttestorTestIamPermissionCall struct">ProjectAttestorTestIamPermissionCall</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.ProjectAttestorUpdateCall.html" title="google_binaryauthorization1_beta1::api::ProjectAttestorUpdateCall struct">ProjectAttestorUpdateCall</a></td><td class="docblock-short"><p>Updates an attestor. Returns NOT_FOUND if the attestor does not exist.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectAttestorValidateAttestationOccurrenceCall.html" title="google_binaryauthorization1_beta1::api::ProjectAttestorValidateAttestationOccurrenceCall struct">ProjectAttestorValidateAttestationOccurrenceCall</a></td><td class="docblock-short"><p>Returns whether the given Attestation for the given image URI was signed by the given Attestor</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectGetPolicyCall.html" title="google_binaryauthorization1_beta1::api::ProjectGetPolicyCall struct">ProjectGetPolicyCall</a></td><td class="docblock-short"><p>A policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy. Gets the policy for this project. Returns a default policy if the project does not have one.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_binaryauthorization1_beta1::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>BinaryAuthorization</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectPolicyGetIamPolicyCall.html" title="google_binaryauthorization1_beta1::api::ProjectPolicyGetIamPolicyCall struct">ProjectPolicyGetIamPolicyCall</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.ProjectPolicySetIamPolicyCall.html" title="google_binaryauthorization1_beta1::api::ProjectPolicySetIamPolicyCall struct">ProjectPolicySetIamPolicyCall</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.ProjectPolicyTestIamPermissionCall.html" title="google_binaryauthorization1_beta1::api::ProjectPolicyTestIamPermissionCall struct">ProjectPolicyTestIamPermissionCall</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.ProjectUpdatePolicyCall.html" title="google_binaryauthorization1_beta1::api::ProjectUpdatePolicyCall struct">ProjectUpdatePolicyCall</a></td><td class="docblock-short"><p>Creates or updates a project's policy, and returns a copy of the new policy. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetIamPolicyRequest.html" title="google_binaryauthorization1_beta1::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.Signature.html" title="google_binaryauthorization1_beta1::api::Signature struct">Signature</a></td><td class="docblock-short"><p>Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from <code>public_key_id</code> to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature <code>public_key_id</code> as anything more than a key lookup hint. The <code>public_key_id</code> DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The <code>public_key_id</code> is not recognized by the verifier. * The public key that <code>public_key_id</code> refers to does not verify the signature with respect to the payload. The <code>signature</code> contents SHOULD NOT be "attached" (where the payload is included with the serialized <code>signature</code> bytes). Verifiers MUST ignore any "attached" payload and only verify signatures with respect to explicitly provided payload (e.g. a <code>payload</code> field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SystempolicyGetPolicyCall.html" title="google_binaryauthorization1_beta1::api::SystempolicyGetPolicyCall struct">SystempolicyGetPolicyCall</a></td><td class="docblock-short"><p>Gets the current system policy in the specified location.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SystempolicyMethods.html" title="google_binaryauthorization1_beta1::api::SystempolicyMethods struct">SystempolicyMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>systempolicy</em> resources.
|
||
It is not used directly, but through the <code>BinaryAuthorization</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsRequest.html" title="google_binaryauthorization1_beta1::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_binaryauthorization1_beta1::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.UserOwnedDrydockNote.html" title="google_binaryauthorization1_beta1::api::UserOwnedDrydockNote struct">UserOwnedDrydockNote</a></td><td class="docblock-short"><p>An user owned drydock note references a Drydock ATTESTATION_AUTHORITY Note created by the user.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ValidateAttestationOccurrenceRequest.html" title="google_binaryauthorization1_beta1::api::ValidateAttestationOccurrenceRequest struct">ValidateAttestationOccurrenceRequest</a></td><td class="docblock-short"><p>Request message for ValidationHelperV1.ValidateAttestationOccurrence.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ValidateAttestationOccurrenceResponse.html" title="google_binaryauthorization1_beta1::api::ValidateAttestationOccurrenceResponse struct">ValidateAttestationOccurrenceResponse</a></td><td class="docblock-short"><p>Response message for ValidationHelperV1.ValidateAttestationOccurrence.</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_binaryauthorization1_beta1::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_binaryauthorization1_beta1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |