servicenetworking.v1 library Null safety

Service Networking API - v1

Provides automatic management of network configurations necessary for certain services.

For more information, see cloud.google.com/service-infrastructure/docs/service-networking/getting-started

Create an instance of ServiceNetworkingApi to access these resources:

Classes

AddDnsRecordSetRequest
Request to add a record set to a private managed DNS zone in the shared producer host project.
AddDnsZoneRequest
Request to add a private managed DNS zone in the shared producer host project and a matching DNS peering zone in the consumer project.
AddDnsZoneResponse
Represents managed DNS zones created in the shared producer host and consumer projects.
AddRolesRequest
Request for AddRoles to allow Service Producers to add roles in the shared VPC host project for them to use.
AddRolesResponse
Represents IAM roles added to the shared VPC host project.
AddSubnetworkRequest
Request to create a subnetwork in a previously peered service network.
Api
Api is a light-weight descriptor for an API Interface. [...]
Authentication
Authentication defines the authentication configuration for API methods provided by an API service. [...]
AuthenticationRule
Authentication rules for the service. [...]
AuthProvider
Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
Backend
Backend defines the backend configuration for a service.
Billing
Billing related configuration of the service. [...]
Connection
Represents a private connection resource. [...]
ConsumerConfig
Configuration information for a private service access connection.
ConsumerProject
Represents a consumer project.
Context
Context defines which contexts an API requests. [...]
CustomError
Customize service error responses. [...]
DeleteConnectionRequest
Request to delete a private service access connection. [...]
DnsRecordSet
Represents a DNS record set resource.
DnsZone
Represents a DNS zone resource.
Documentation
Documentation provides the information for describing a service. [...]
Enum
Enum type definition.
EnumValue
Enum value definition.
Field
A single field of a message type.
GoogleCloudServicenetworkingV1betaConnection
Represents a private connection resource. [...]
GoogleCloudServicenetworkingV1betaSubnetwork
Represents a subnet that was created or discovered by a private access management service.
GoogleCloudServicenetworkingV1ConsumerConfigReservedRange
Allocated IP address ranges for this private service access connection.
Http
Defines the HTTP configuration for an API service. [...]
HttpRule
gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC [...]
ListConnectionsResponse
ListConnectionsResponse is the response to list peering states for the given service and consumer project.
ListOperationsResponse
The response message for Operations.ListOperations.
ListPeeredDnsDomainsResponse
Response to list peered DNS domains for a given connection.
LogDescriptor
A description of a log type. [...]
Logging
Logging configuration of the service. [...]
Method
Method represents a method of an API interface.
MetricDescriptor
Defines a metric type and its schema. [...]
MonitoredResourceDescriptor
An object that describes the schema of a MonitoredResource object using a type name and a set of labels. [...]
Monitoring
Monitoring configuration of the service. [...]
Operation
This resource represents a long-running operation that is the result of a network API call.
OperationsResource
Page
Represents a documentation page. [...]
PeeredDnsDomain
DNS domain suffix for which requests originating in the producer VPC network are resolved in the associated consumer VPC network.
PolicyBinding
Grouping of IAM role and IAM member.
Quota
Quota configuration helps to achieve fairness and budgeting in service usage. [...]
Range
Represents a found unused range.
RangeReservation
Represents a range reservation.
RemoveDnsRecordSetRequest
Request to remove a record set from a private managed DNS zone in the shared producer host project. [...]
RemoveDnsZoneRequest
Request to remove a private managed DNS zone in the shared producer host project and a matching DNS peering zone in the consumer project.
Route
Represents a route that was created or discovered by a private access management service.
SearchRangeRequest
Request to search for an unused range within allocated ranges.
SecondaryIpRange
SecondaryIpRangeSpec
Service
Service is the root object of Google API service configuration (service config). [...]
ServiceNetworkingApi
Provides automatic management of network configurations necessary for certain services.
ServicesConnectionsResource
ServicesDnsRecordSetsResource
ServicesDnsZonesResource
ServicesProjectsGlobalNetworksPeeredDnsDomainsResource
ServicesProjectsGlobalNetworksResource
ServicesProjectsGlobalResource
ServicesProjectsResource
ServicesResource
ServicesRolesResource
Subnetwork
Represents a subnet that was created or discovered by a private access management service.
SystemParameterRule
Define a system parameter rule mapping system parameter definitions to methods.
SystemParameters
System parameter configuration A system parameter is a special kind of [...]
Type
A protocol buffer message type.
UpdateConsumerConfigRequest
Request to update the configuration of a service networking connection including the import/export of custom routes and subnetwork routes with public IP.
UpdateDnsRecordSetRequest
Request to update a record set from a private managed DNS zone in the shared producer host project. [...]
Usage
Configuration controlling usage of a service.
ValidateConsumerConfigRequest
ValidateConsumerConfigResponse

Typedefs

AddDnsRecordSetMetadata = $Empty
Metadata provided through GetOperation request for the LRO generated by AddDnsRecordSet API
AddDnsZoneMetadata = $Empty
Metadata provided through GetOperation request for the LRO generated by AddDnsZone API
AddRolesMetadata = $Empty
Metadata provided through GetOperation request for the LRO generated by AddRoles API
AuthRequirement = $AuthRequirement
User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
BackendRule = $BackendRule
A backend rule provides configuration for an individual API element.
BillingDestination = $BillingDestination
Configuration of a specific billing destination (Currently only support bill against consumer project).
CancelOperationRequest = $Empty
The request message for Operations.CancelOperation.
ConsumerConfigMetadata = $Empty
Metadata provided through GetOperation request for the LRO generated by UpdateConsumerConfig API.
ContextRule = $ContextRule
A context rule provides information about the context for an individual API element.
Control = $Control
Selects and configures the service controller used by the service. [...]
CustomErrorRule = $CustomErrorRule
A custom error rule.
CustomHttpPattern = $CustomHttpPattern
A custom pattern is used for defining custom HTTP verb.
DeleteConnectionMetadata = $Empty
Metadata provided through GetOperation request for the LRO generated by Delete Connection API
DeletePeeredDnsDomainMetadata = $Empty
Metadata provided through GetOperation request for the LRO generated by DeletePeeredDnsDomain API.
DisableVpcServiceControlsRequest = $VpcServiceControlsRequest
Request to disable VPC service controls.
DocumentationRule = $DocumentationRule
A documentation rule provides information about individual API elements.
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
EnableVpcServiceControlsRequest = $VpcServiceControlsRequest
Request to enable VPC service controls.
Endpoint = $Endpoint
Endpoint describes a network address of a service that serves a set of APIs. [...]
JwtLocation = $JwtLocation
Specifies a location to extract JWT from an API request.
LabelDescriptor = $LabelDescriptor
A description of a label.
LoggingDestination = $LoggingDestination
Configuration of a specific logging destination (the producer project or the consumer project).
MetricDescriptorMetadata = $MetricDescriptorMetadata00
Additional annotations that can be used to guide the usage of a metric.
MetricRule = $MetricRule
Bind API methods to metrics. [...]
Mixin = $Mixin
Declares an API Interface to be included in this interface. [...]
MonitoringDestination = $MonitoringDestination
Configuration of a specific monitoring destination (the producer project or the consumer project).
OAuthRequirements = $OAuthRequirements
OAuth scopes are a way to define data and permissions on data. [...]
Option = $Option
A protocol buffer option, which can be attached to a message, field, enumeration, etc.
PartialDeleteConnectionMetadata = $Empty
Metadata provided through GetOperation request for the LRO generated by Partial Delete Connection API
PeeredDnsDomainMetadata = $Empty
Metadata provided through GetOperation request for the LRO generated by CreatePeeredDnsDomain API.
QuotaLimit = $QuotaLimit
QuotaLimit defines a specific limit that applies over a specified duration for a limit type. [...]
RemoveDnsRecordSetMetadata = $Empty
Metadata provided through GetOperation request for the LRO generated by RemoveDnsRecordSet API
RemoveDnsRecordSetResponse = $Empty
Blank message response type for RemoveDnsRecordSet API
RemoveDnsZoneMetadata = $Empty
Metadata provided through GetOperation request for the LRO generated by RemoveDnsZone API
RemoveDnsZoneResponse = $Empty
Blank message response type for RemoveDnsZone API
SourceContext = $SourceContext
SourceContext represents information about the source of a protobuf element, like the file in which it is defined.
SourceInfo = $SourceInfo
Source information used to create a Service Config
Status = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. [...]
SystemParameter = $SystemParameter
Define a parameter's name and location. [...]
UpdateDnsRecordSetMetadata = $Empty
Metadata provided through GetOperation request for the LRO generated by UpdateDnsRecordSet API
UsageRule = $UsageRule
Usage configuration rules for the service. [...]

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.