Module api

Source

Structs§

AddAddressGroupItemsRequest
Request used by the AddAddressGroupItems method.
AddressGroup
AddressGroup is a resource that specifies how a collection of IP/DNS used in Firewall Policy.
AuthorizationPolicy
AuthorizationPolicy is a resource that specifies how a server should authorize incoming connections. This resource in itself does not change the configuration unless it’s attached to a target https proxy or endpoint config selector resource.
CancelOperationRequest
The request message for Operations.CancelOperation.
CertificateProviderInstance
Specification of a TLS certificate provider instance. Workloads may have one or more CertificateProvider instances (plugins) and one of them is enabled and configured by specifying this message. Workloads use the values from this message to locate and load the CertificateProvider instance configuration.
ClientTlsPolicy
ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.
CloneAddressGroupItemsRequest
Request used by the CloneAddressGroupItems method.
Destination
Specification of traffic destination attributes.
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); }
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.
FirewallEndpoint
Message describing Endpoint object
FirewallEndpointAssociation
Message describing Association object
FirewallEndpointAssociationReference
This is a subset of the FirewallEndpointAssociation message, containing fields to be used by the consumer.
GatewaySecurityPolicy
The GatewaySecurityPolicy resource contains a collection of GatewaySecurityPolicyRules and associated metadata.
GatewaySecurityPolicyRule
The GatewaySecurityPolicyRule resource is in a nested collection within a GatewaySecurityPolicy and represents a traffic matching condition and associated action to perform.
GoogleCloudNetworksecurityV1CertificateProvider
Specification of certificate provider. Defines the mechanism to obtain the certificate and private key for peer to peer authentication.
GoogleCloudNetworksecurityV1GrpcEndpoint
Specification of the GRPC Endpoint.
GoogleIamV1AuditConfig
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.
GoogleIamV1AuditLogConfig
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.
GoogleIamV1Binding
Associates members, or principals, with a role.
GoogleIamV1Policy
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.
GoogleIamV1SetIamPolicyRequest
Request message for SetIamPolicy method.
GoogleIamV1TestIamPermissionsRequest
Request message for TestIamPermissions method.
GoogleIamV1TestIamPermissionsResponse
Response message for TestIamPermissions method.
HttpHeaderMatch
Specification of HTTP header match attributes.
ListAddressGroupReferencesResponse
Response of the ListAddressGroupReferences method.
ListAddressGroupReferencesResponseAddressGroupReference
The Reference of AddressGroup.
ListAddressGroupsResponse
Response returned by the ListAddressGroups method.
ListAuthorizationPoliciesResponse
Response returned by the ListAuthorizationPolicies method.
ListClientTlsPoliciesResponse
Response returned by the ListClientTlsPolicies method.
ListFirewallEndpointAssociationsResponse
Message for response to listing Associations
ListFirewallEndpointsResponse
Message for response to listing Endpoints
ListGatewaySecurityPoliciesResponse
Response returned by the ListGatewaySecurityPolicies method.
ListGatewaySecurityPolicyRulesResponse
Response returned by the ListGatewaySecurityPolicyRules method.
ListLocationsResponse
The response message for Locations.ListLocations.
ListOperationsResponse
The response message for Operations.ListOperations.
ListSecurityProfileGroupsResponse
Response returned by the ListSecurityProfileGroups method.
ListSecurityProfilesResponse
Response returned by the ListSecurityProfiles method.
ListServerTlsPoliciesResponse
Response returned by the ListServerTlsPolicies method.
ListTlsInspectionPoliciesResponse
Response returned by the ListTlsInspectionPolicies method.
ListUrlListsResponse
Response returned by the ListUrlLists method.
Location
A resource that represents a Google Cloud location.
MTLSPolicy
Specification of the MTLSPolicy.
NetworkSecurity
Central instance to access all NetworkSecurity related resource activities
Operation
This resource represents a long-running operation that is the result of a network API call.
OrganizationLocationAddressGroupAddItemCall
Adds items to an address group.
OrganizationLocationAddressGroupCloneItemCall
Clones items from one address group to another.
OrganizationLocationAddressGroupCreateCall
Creates a new address group in a given project and location.
OrganizationLocationAddressGroupDeleteCall
Deletes an address group.
OrganizationLocationAddressGroupGetCall
Gets details of a single address group.
OrganizationLocationAddressGroupListCall
Lists address groups in a given project and location.
OrganizationLocationAddressGroupListReferenceCall
Lists references of an address group.
OrganizationLocationAddressGroupPatchCall
Updates parameters of an address group.
OrganizationLocationAddressGroupRemoveItemCall
Removes items from an address group.
OrganizationLocationFirewallEndpointCreateCall
Creates a new FirewallEndpoint in a given project and location.
OrganizationLocationFirewallEndpointDeleteCall
Deletes a single Endpoint.
OrganizationLocationFirewallEndpointGetCall
Gets details of a single Endpoint.
OrganizationLocationFirewallEndpointListCall
Lists FirewallEndpoints in a given project and location.
OrganizationLocationFirewallEndpointPatchCall
Update a single Endpoint.
OrganizationLocationOperationCancelCall
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.
OrganizationLocationOperationDeleteCall
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.
OrganizationLocationOperationGetCall
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.
OrganizationLocationOperationListCall
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
OrganizationLocationSecurityProfileCreateCall
Creates a new SecurityProfile in a given organization and location.
OrganizationLocationSecurityProfileDeleteCall
Deletes a single SecurityProfile.
OrganizationLocationSecurityProfileGetCall
Gets details of a single SecurityProfile.
OrganizationLocationSecurityProfileGroupCreateCall
Creates a new SecurityProfileGroup in a given organization and location.
OrganizationLocationSecurityProfileGroupDeleteCall
Deletes a single SecurityProfileGroup.
OrganizationLocationSecurityProfileGroupGetCall
Gets details of a single SecurityProfileGroup.
OrganizationLocationSecurityProfileGroupListCall
Lists SecurityProfileGroups in a given organization and location.
OrganizationLocationSecurityProfileGroupPatchCall
Updates the parameters of a single SecurityProfileGroup.
OrganizationLocationSecurityProfileListCall
Lists SecurityProfiles in a given organization and location.
OrganizationLocationSecurityProfilePatchCall
Updates the parameters of a single SecurityProfile.
OrganizationMethods
A builder providing access to all methods supported on organization resources. It is not used directly, but through the NetworkSecurity hub.
ProjectLocationAddressGroupAddItemCall
Adds items to an address group.
ProjectLocationAddressGroupCloneItemCall
Clones items from one address group to another.
ProjectLocationAddressGroupCreateCall
Creates a new address group in a given project and location.
ProjectLocationAddressGroupDeleteCall
Deletes a single address group.
ProjectLocationAddressGroupGetCall
Gets details of a single address group.
ProjectLocationAddressGroupGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationAddressGroupListCall
Lists address groups in a given project and location.
ProjectLocationAddressGroupListReferenceCall
Lists references of an address group.
ProjectLocationAddressGroupPatchCall
Updates the parameters of a single address group.
ProjectLocationAddressGroupRemoveItemCall
Removes items from an address group.
ProjectLocationAddressGroupSetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectLocationAddressGroupTestIamPermissionCall
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.
ProjectLocationAuthorizationPolicyCreateCall
Creates a new AuthorizationPolicy in a given project and location.
ProjectLocationAuthorizationPolicyDeleteCall
Deletes a single AuthorizationPolicy.
ProjectLocationAuthorizationPolicyGetCall
Gets details of a single AuthorizationPolicy.
ProjectLocationAuthorizationPolicyGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationAuthorizationPolicyListCall
Lists AuthorizationPolicies in a given project and location.
ProjectLocationAuthorizationPolicyPatchCall
Updates the parameters of a single AuthorizationPolicy.
ProjectLocationAuthorizationPolicySetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectLocationAuthorizationPolicyTestIamPermissionCall
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.
ProjectLocationClientTlsPolicyCreateCall
Creates a new ClientTlsPolicy in a given project and location.
ProjectLocationClientTlsPolicyDeleteCall
Deletes a single ClientTlsPolicy.
ProjectLocationClientTlsPolicyGetCall
Gets details of a single ClientTlsPolicy.
ProjectLocationClientTlsPolicyGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationClientTlsPolicyListCall
Lists ClientTlsPolicies in a given project and location.
ProjectLocationClientTlsPolicyPatchCall
Updates the parameters of a single ClientTlsPolicy.
ProjectLocationClientTlsPolicySetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectLocationClientTlsPolicyTestIamPermissionCall
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.
ProjectLocationFirewallEndpointAssociationCreateCall
Creates a new FirewallEndpointAssociation in a given project and location.
ProjectLocationFirewallEndpointAssociationDeleteCall
Deletes a single FirewallEndpointAssociation.
ProjectLocationFirewallEndpointAssociationGetCall
Gets details of a single FirewallEndpointAssociation.
ProjectLocationFirewallEndpointAssociationListCall
Lists Associations in a given project and location.
ProjectLocationFirewallEndpointAssociationPatchCall
Update a single FirewallEndpointAssociation.
ProjectLocationGatewaySecurityPolicyCreateCall
Creates a new GatewaySecurityPolicy in a given project and location.
ProjectLocationGatewaySecurityPolicyDeleteCall
Deletes a single GatewaySecurityPolicy.
ProjectLocationGatewaySecurityPolicyGetCall
Gets details of a single GatewaySecurityPolicy.
ProjectLocationGatewaySecurityPolicyListCall
Lists GatewaySecurityPolicies in a given project and location.
ProjectLocationGatewaySecurityPolicyPatchCall
Updates the parameters of a single GatewaySecurityPolicy.
ProjectLocationGatewaySecurityPolicyRuleCreateCall
Creates a new GatewaySecurityPolicy in a given project and location.
ProjectLocationGatewaySecurityPolicyRuleDeleteCall
Deletes a single GatewaySecurityPolicyRule.
ProjectLocationGatewaySecurityPolicyRuleGetCall
Gets details of a single GatewaySecurityPolicyRule.
ProjectLocationGatewaySecurityPolicyRuleListCall
Lists GatewaySecurityPolicyRules in a given project and location.
ProjectLocationGatewaySecurityPolicyRulePatchCall
Updates the parameters of a single GatewaySecurityPolicyRule.
ProjectLocationGetCall
Gets information about a location.
ProjectLocationListCall
Lists information about the supported locations for this service.
ProjectLocationOperationCancelCall
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.
ProjectLocationOperationDeleteCall
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.
ProjectLocationOperationGetCall
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.
ProjectLocationOperationListCall
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
ProjectLocationServerTlsPolicyCreateCall
Creates a new ServerTlsPolicy in a given project and location.
ProjectLocationServerTlsPolicyDeleteCall
Deletes a single ServerTlsPolicy.
ProjectLocationServerTlsPolicyGetCall
Gets details of a single ServerTlsPolicy.
ProjectLocationServerTlsPolicyGetIamPolicyCall
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationServerTlsPolicyListCall
Lists ServerTlsPolicies in a given project and location.
ProjectLocationServerTlsPolicyPatchCall
Updates the parameters of a single ServerTlsPolicy.
ProjectLocationServerTlsPolicySetIamPolicyCall
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectLocationServerTlsPolicyTestIamPermissionCall
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.
ProjectLocationTlsInspectionPolicyCreateCall
Creates a new TlsInspectionPolicy in a given project and location.
ProjectLocationTlsInspectionPolicyDeleteCall
Deletes a single TlsInspectionPolicy.
ProjectLocationTlsInspectionPolicyGetCall
Gets details of a single TlsInspectionPolicy.
ProjectLocationTlsInspectionPolicyListCall
Lists TlsInspectionPolicies in a given project and location.
ProjectLocationTlsInspectionPolicyPatchCall
Updates the parameters of a single TlsInspectionPolicy.
ProjectLocationUrlListCreateCall
Creates a new UrlList in a given project and location.
ProjectLocationUrlListDeleteCall
Deletes a single UrlList.
ProjectLocationUrlListGetCall
Gets details of a single UrlList.
ProjectLocationUrlListListCall
Lists UrlLists in a given project and location.
ProjectLocationUrlListPatchCall
Updates the parameters of a single UrlList.
ProjectMethods
A builder providing access to all methods supported on project resources. It is not used directly, but through the NetworkSecurity hub.
RemoveAddressGroupItemsRequest
Request used by the RemoveAddressGroupItems method.
Rule
Specification of rules.
SecurityProfile
SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 10
SecurityProfileGroup
SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 9
ServerTlsPolicy
ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by external HTTPS load balancers can be attached only to TargetHttpsProxy with an EXTERNAL or EXTERNAL_MANAGED load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director INTERNAL_SELF_MANAGED load balancing scheme.
SeverityOverride
Defines what action to take for a specific severity match.
Source
Specification of traffic source attributes.
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.
ThreatOverride
Defines what action to take for a specific threat_id match.
ThreatPreventionProfile
ThreatPreventionProfile defines an action for specific threat signatures or severity levels.
TlsInspectionPolicy
The TlsInspectionPolicy resource contains references to CA pools in Certificate Authority Service and associated metadata.
UrlList
UrlList proto helps users to set reusable, independently manageable lists of hosts, host patterns, URLs, URL patterns.
ValidationCA
Specification of ValidationCA. Defines the mechanism to obtain the Certificate Authority certificate to validate the peer certificate.

Enums§

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