mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
56 lines
21 KiB
HTML
56 lines
21 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_servicedirectory1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_servicedirectory1::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_servicedirectory1/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_servicedirectory1</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_servicedirectory1</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_servicedirectory1/api.rs.html#1-8115" 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.Binding.html" title="google_servicedirectory1::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_servicedirectory1::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.Endpoint.html" title="google_servicedirectory1::api::Endpoint struct">Endpoint</a></td><td class="docblock-short"><p>An individual endpoint that provides a service. The service must already exist to create an endpoint.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Expr.html" title="google_servicedirectory1::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.GetIamPolicyRequest.html" title="google_servicedirectory1::api::GetIamPolicyRequest struct">GetIamPolicyRequest</a></td><td class="docblock-short"><p>Request message for <code>GetIamPolicy</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetPolicyOptions.html" title="google_servicedirectory1::api::GetPolicyOptions struct">GetPolicyOptions</a></td><td class="docblock-short"><p>Encapsulates settings provided to GetIamPolicy.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListEndpointsResponse.html" title="google_servicedirectory1::api::ListEndpointsResponse struct">ListEndpointsResponse</a></td><td class="docblock-short"><p>The response message for RegistrationService.ListEndpoints.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListLocationsResponse.html" title="google_servicedirectory1::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.ListNamespacesResponse.html" title="google_servicedirectory1::api::ListNamespacesResponse struct">ListNamespacesResponse</a></td><td class="docblock-short"><p>The response message for RegistrationService.ListNamespaces.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListServicesResponse.html" title="google_servicedirectory1::api::ListServicesResponse struct">ListServicesResponse</a></td><td class="docblock-short"><p>The response message for RegistrationService.ListServices.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Location.html" title="google_servicedirectory1::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.Namespace.html" title="google_servicedirectory1::api::Namespace struct">Namespace</a></td><td class="docblock-short"><p>A container for services. Namespaces allow administrators to group services together and define permissions for a collection of services.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Policy.html" title="google_servicedirectory1::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_servicedirectory1::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.ProjectLocationListCall.html" title="google_servicedirectory1::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.ProjectLocationNamespaceCreateCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceCreateCall struct">ProjectLocationNamespaceCreateCall</a></td><td class="docblock-short"><p>Creates a namespace, and returns the new namespace.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceDeleteCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceDeleteCall struct">ProjectLocationNamespaceDeleteCall</a></td><td class="docblock-short"><p>Deletes a namespace. This also deletes all services and endpoints in the namespace.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceGetCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceGetCall struct">ProjectLocationNamespaceGetCall</a></td><td class="docblock-short"><p>Gets a namespace.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceGetIamPolicyCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceGetIamPolicyCall struct">ProjectLocationNamespaceGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the IAM Policy for a resource (namespace or service only).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceListCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceListCall struct">ProjectLocationNamespaceListCall</a></td><td class="docblock-short"><p>Lists all namespaces.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespacePatchCall.html" title="google_servicedirectory1::api::ProjectLocationNamespacePatchCall struct">ProjectLocationNamespacePatchCall</a></td><td class="docblock-short"><p>Updates a namespace.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceCreateCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceCreateCall struct">ProjectLocationNamespaceServiceCreateCall</a></td><td class="docblock-short"><p>Creates a service, and returns the new service.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceDeleteCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceDeleteCall struct">ProjectLocationNamespaceServiceDeleteCall</a></td><td class="docblock-short"><p>Deletes a service. This also deletes all endpoints associated with the service.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceEndpointCreateCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceEndpointCreateCall struct">ProjectLocationNamespaceServiceEndpointCreateCall</a></td><td class="docblock-short"><p>Creates an endpoint, and returns the new endpoint.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceEndpointDeleteCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceEndpointDeleteCall struct">ProjectLocationNamespaceServiceEndpointDeleteCall</a></td><td class="docblock-short"><p>Deletes an endpoint.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceEndpointGetCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceEndpointGetCall struct">ProjectLocationNamespaceServiceEndpointGetCall</a></td><td class="docblock-short"><p>Gets an endpoint.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceEndpointListCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceEndpointListCall struct">ProjectLocationNamespaceServiceEndpointListCall</a></td><td class="docblock-short"><p>Lists all endpoints.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceEndpointPatchCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceEndpointPatchCall struct">ProjectLocationNamespaceServiceEndpointPatchCall</a></td><td class="docblock-short"><p>Updates an endpoint.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceGetCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceGetCall struct">ProjectLocationNamespaceServiceGetCall</a></td><td class="docblock-short"><p>Gets a service.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceGetIamPolicyCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceGetIamPolicyCall struct">ProjectLocationNamespaceServiceGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the IAM Policy for a resource (namespace or service only).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceListCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceListCall struct">ProjectLocationNamespaceServiceListCall</a></td><td class="docblock-short"><p>Lists all services belonging to a namespace.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServicePatchCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServicePatchCall struct">ProjectLocationNamespaceServicePatchCall</a></td><td class="docblock-short"><p>Updates a service.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceResolveCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceResolveCall struct">ProjectLocationNamespaceServiceResolveCall</a></td><td class="docblock-short"><p>Returns a service and its associated endpoints. Resolving a service is not considered an active developer method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceSetIamPolicyCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceSetIamPolicyCall struct">ProjectLocationNamespaceServiceSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the IAM Policy for a resource (namespace or service only).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceServiceTestIamPermissionCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceServiceTestIamPermissionCall struct">ProjectLocationNamespaceServiceTestIamPermissionCall</a></td><td class="docblock-short"><p>Tests IAM permissions for a resource (namespace or service only).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceSetIamPolicyCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceSetIamPolicyCall struct">ProjectLocationNamespaceSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the IAM Policy for a resource (namespace or service only).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationNamespaceTestIamPermissionCall.html" title="google_servicedirectory1::api::ProjectLocationNamespaceTestIamPermissionCall struct">ProjectLocationNamespaceTestIamPermissionCall</a></td><td class="docblock-short"><p>Tests IAM permissions for a resource (namespace or service only).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_servicedirectory1::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>ServiceDirectory</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResolveServiceRequest.html" title="google_servicedirectory1::api::ResolveServiceRequest struct">ResolveServiceRequest</a></td><td class="docblock-short"><p>The request message for LookupService.ResolveService. Looks up a service by its name, returns the service and its endpoints.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResolveServiceResponse.html" title="google_servicedirectory1::api::ResolveServiceResponse struct">ResolveServiceResponse</a></td><td class="docblock-short"><p>The response message for LookupService.ResolveService.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Service.html" title="google_servicedirectory1::api::Service struct">Service</a></td><td class="docblock-short"><p>An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ServiceDirectory.html" title="google_servicedirectory1::api::ServiceDirectory struct">ServiceDirectory</a></td><td class="docblock-short"><p>Central instance to access all ServiceDirectory related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetIamPolicyRequest.html" title="google_servicedirectory1::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.TestIamPermissionsRequest.html" title="google_servicedirectory1::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_servicedirectory1::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_servicedirectory1::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_servicedirectory1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |