Module api

Source

Structs§

AbortInfo
Details of the final state “abort” and associated resource.
AppEngineVersionEndpoint
Wrapper for the App Engine service version attributes.
AppEngineVersionInfo
For display only. Metadata associated with an App Engine version.
AuditConfig
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { “audit_configs”: [ { “service”: “allServices”, “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:jose@example.com” ] }, { “log_type”: “DATA_WRITE” }, { “log_type”: “ADMIN_READ” } ] }, { “service”: “sampleservice.googleapis.com”, “audit_log_configs”: [ { “log_type”: “DATA_READ” }, { “log_type”: “DATA_WRITE”, “exempted_members”: [ “user:aliya@example.com” ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
AuditLogConfig
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.
Binding
Associates members, or principals, with a role.
CancelOperationRequest
The request message for Operations.CancelOperation.
CloudFunctionEndpoint
Wrapper for Cloud Function attributes.
CloudFunctionInfo
For display only. Metadata associated with a Cloud Function.
CloudRunRevisionEndpoint
Wrapper for Cloud Run revision attributes.
CloudRunRevisionInfo
For display only. Metadata associated with a Cloud Run revision.
CloudSQLInstanceInfo
For display only. Metadata associated with a Cloud SQL instance.
ConnectivityTest
A Connectivity Test for a network reachability analysis.
DeliverInfo
Details of the final state “deliver” and associated resource.
DropInfo
Details of the final state “drop” and associated resource.
EdgeLocation
Representation of a network edge location as per https://cloud.google.com/vpc/docs/edge-locations.
Empty
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); }
Endpoint
Source or destination of the Connectivity Test.
EndpointInfo
For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model.
Expr
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.
FirewallInfo
For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule.
ForwardInfo
Details of the final state “forward” and associated resource.
ForwardingRuleInfo
For display only. Metadata associated with a Compute Engine forwarding rule.
GKEMasterInfo
For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master.
GoogleServiceInfo
For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths
InstanceInfo
For display only. Metadata associated with a Compute Engine instance.
LatencyDistribution
Describes measured latency distribution.
LatencyPercentile
Latency percentile rank and value.
ListConnectivityTestsResponse
Response for the ListConnectivityTests method.
ListLocationsResponse
The response message for Locations.ListLocations.
ListOperationsResponse
The response message for Operations.ListOperations.
LoadBalancerBackend
For display only. Metadata associated with a specific load balancer backend.
LoadBalancerBackendInfo
For display only. Metadata associated with the load balancer backend.
LoadBalancerInfo
For display only. Metadata associated with a load balancer.
Location
A resource that represents a Google Cloud location.
NatInfo
For display only. Metadata associated with NAT.
NetworkInfo
For display only. Metadata associated with a Compute Engine network.
NetworkManagement
Central instance to access all NetworkManagement related resource activities
Operation
This resource represents a long-running operation that is the result of a network API call.
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.
ProbingDetails
Results of active probing from the last run of the test.
ProjectLocationGetCall
Gets information about a location.
ProjectLocationGlobalConnectivityTestCreateCall
Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. If the endpoint specifications in ConnectivityTest are invalid (for example, containing non-existent resources in the network, or you don’t have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN. If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. For more information, see the Connectivity Test documentation.
ProjectLocationGlobalConnectivityTestDeleteCall
Deletes a specific ConnectivityTest.
ProjectLocationGlobalConnectivityTestGetCall
Gets the details of a specific Connectivity Test.
ProjectLocationGlobalConnectivityTestGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationGlobalConnectivityTestListCall
Lists all Connectivity Tests owned by a project.
ProjectLocationGlobalConnectivityTestPatchCall
Updates the configuration of an existing ConnectivityTest. After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result. If the endpoint specifications in ConnectivityTest are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN. If the endpoint specifications in ConnectivityTest are incomplete, the reachability result returns a value of AMBIGUOUS. See the documentation in ConnectivityTest for more details.
ProjectLocationGlobalConnectivityTestRerunCall
Rerun an existing ConnectivityTest. After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes. If the endpoint specifications in ConnectivityTest become invalid (for example, specified resources are deleted in the network, or you lost read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN.
ProjectLocationGlobalConnectivityTestSetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectLocationGlobalConnectivityTestTestIamPermissionCall
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
ProjectLocationGlobalOperationCancelCall
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
ProjectLocationGlobalOperationDeleteCall
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectLocationGlobalOperationGetCall
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.
ProjectLocationGlobalOperationListCall
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
ProjectLocationListCall
Lists information about the supported locations for this service.
ProjectMethods
A builder providing access to all methods supported on project resources. It is not used directly, but through the NetworkManagement hub.
ProxyConnectionInfo
For display only. Metadata associated with ProxyConnection.
ReachabilityDetails
Results of the configuration analysis from the last run of the test.
RerunConnectivityTestRequest
Request for the RerunConnectivityTest method.
RouteInfo
For display only. Metadata associated with a Compute Engine route.
ServerlessNegInfo
For display only. Metadata associated with the serverless network endpoint group backend.
SetIamPolicyRequest
Request message for SetIamPolicy method.
Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Step
A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration.
StorageBucketInfo
For display only. Metadata associated with Storage Bucket.
TestIamPermissionsRequest
Request message for TestIamPermissions method.
TestIamPermissionsResponse
Response message for TestIamPermissions method.
Trace
Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final))
VpcConnectorInfo
For display only. Metadata associated with a VPC connector.
VpnGatewayInfo
For display only. Metadata associated with a Compute Engine VPN gateway.
VpnTunnelInfo
For display only. Metadata associated with a Compute Engine VPN tunnel.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.