Service Networking API: services. Provides automatic management of network configurations necessary for certain services. See: https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services
Service Networking API: services. Provides automatic management of network configurations necessary for certain services. See: https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services
(addSubnetwork$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:role string, :description string, :consumer string, :consumerNetwork string, :purpose string, :privateIpv6GoogleAccess string, :internalRange string, :subnetworkUsers [string], :checkServiceNetworkingUsePermission boolean, :outsideAllocationPublicIpRange string, :useCustomComputeIdempotencyWindow boolean, :requestedAddress string, :region string, :ipPrefixLength integer, :allowSubnetCidrRoutesOverlap boolean, :computeIdempotencyWindow string, :requestedRanges [string], :secondaryIpRangeSpecs [{:requestedAddress string, :ipPrefixLength integer, :rangeName string, :outsideAllocationPublicIpRange string}], :subnetwork string}
For service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed as a CIDR range (number of leading bits of ipV4 network mask). The method checks against the assigned allocated ranges to find a non-conflicting IP address range. The method will reuse a subnet if subsequent calls contain the same subnet name, region, and prefix length. This method will make producer's tenant project to be a shared VPC service project as needed.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/addSubnetwork Required parameters: parent Optional parameters: none Body: {:role string, :description string, :consumer string, :consumerNetwork string, :purpose string, :privateIpv6GoogleAccess string, :internalRange string, :subnetworkUsers [string], :checkServiceNetworkingUsePermission boolean, :outsideAllocationPublicIpRange string, :useCustomComputeIdempotencyWindow boolean, :requestedAddress string, :region string, :ipPrefixLength integer, :allowSubnetCidrRoutesOverlap boolean, :computeIdempotencyWindow string, :requestedRanges [string], :secondaryIpRangeSpecs [{:requestedAddress string, :ipPrefixLength integer, :rangeName string, :outsideAllocationPublicIpRange string}], :subnetwork string} For service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed as a CIDR range (number of leading bits of ipV4 network mask). The method checks against the assigned allocated ranges to find a non-conflicting IP address range. The method will reuse a subnet if subsequent calls contain the same subnet name, region, and prefix length. This method will make producer's tenant project to be a shared VPC service project as needed.
(connections-create$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:peering string, :service string, :reservedPeeringRanges [string], :network string}
Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/connections/create Required parameters: parent Optional parameters: none Body: {:peering string, :service string, :reservedPeeringRanges [string], :network string} Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once.
(connections-deleteConnection$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:consumerNetwork string}
Deletes a private service access connection.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/connections/deleteConnection Required parameters: name Optional parameters: none Body: {:consumerNetwork string} Deletes a private service access connection.
(connections-list$ auth parameters)
Required parameters: parent
Optional parameters: network
List the private connections that are configured in a service consumer's VPC network.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/connections/list Required parameters: parent Optional parameters: network List the private connections that are configured in a service consumer's VPC network.
(connections-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask, force
Body:
{:peering string, :service string, :reservedPeeringRanges [string], :network string}
Updates the allocated ranges that are assigned to a connection.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/connections/patch Required parameters: name Optional parameters: updateMask, force Body: {:peering string, :service string, :reservedPeeringRanges [string], :network string} Updates the allocated ranges that are assigned to a connection.
(disableVpcServiceControls$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:consumerNetwork string}
Disables VPC service controls for a connection.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/disableVpcServiceControls Required parameters: parent Optional parameters: none Body: {:consumerNetwork string} Disables VPC service controls for a connection.
(dnsRecordSets-add$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:dnsRecordSet {:data [string], :type string, :domain string, :ttl string}, :consumerNetwork string, :zone string}
Service producers can use this method to add DNS record sets to private DNS zones in the shared producer host project.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/dnsRecordSets/add Required parameters: parent Optional parameters: none Body: {:dnsRecordSet {:data [string], :type string, :domain string, :ttl string}, :consumerNetwork string, :zone string} Service producers can use this method to add DNS record sets to private DNS zones in the shared producer host project.
(dnsRecordSets-get$ auth parameters)
Required parameters: parent
Optional parameters: zone, domain, type, consumerNetwork
Producers can use this method to retrieve information about the DNS record set added to the private zone inside the shared tenant host project associated with a consumer network.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/dnsRecordSets/get Required parameters: parent Optional parameters: zone, domain, type, consumerNetwork Producers can use this method to retrieve information about the DNS record set added to the private zone inside the shared tenant host project associated with a consumer network.
(dnsRecordSets-list$ auth parameters)
Required parameters: parent
Optional parameters: consumerNetwork, zone
Producers can use this method to retrieve a list of available DNS RecordSets available inside the private zone on the tenant host project accessible from their network.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/dnsRecordSets/list Required parameters: parent Optional parameters: consumerNetwork, zone Producers can use this method to retrieve a list of available DNS RecordSets available inside the private zone on the tenant host project accessible from their network.
(dnsRecordSets-remove$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:dnsRecordSet {:data [string], :type string, :domain string, :ttl string}, :consumerNetwork string, :zone string}
Service producers can use this method to remove DNS record sets from private DNS zones in the shared producer host project.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/dnsRecordSets/remove Required parameters: parent Optional parameters: none Body: {:dnsRecordSet {:data [string], :type string, :domain string, :ttl string}, :consumerNetwork string, :zone string} Service producers can use this method to remove DNS record sets from private DNS zones in the shared producer host project.
(dnsRecordSets-update$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:zone string, :consumerNetwork string, :newDnsRecordSet {:data [string], :type string, :domain string, :ttl string}, :existingDnsRecordSet {:data [string], :type string, :domain string, :ttl string}}
Service producers can use this method to update DNS record sets from private DNS zones in the shared producer host project.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/dnsRecordSets/update Required parameters: parent Optional parameters: none Body: {:zone string, :consumerNetwork string, :newDnsRecordSet {:data [string], :type string, :domain string, :ttl string}, :existingDnsRecordSet {:data [string], :type string, :domain string, :ttl string}} Service producers can use this method to update DNS record sets from private DNS zones in the shared producer host project.
(dnsZones-add$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:dnsSuffix string, :name string, :consumerNetwork string}
Service producers can use this method to add private DNS zones in the shared producer host project and matching peering zones in the consumer project.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/dnsZones/add Required parameters: parent Optional parameters: none Body: {:dnsSuffix string, :name string, :consumerNetwork string} Service producers can use this method to add private DNS zones in the shared producer host project and matching peering zones in the consumer project.
(dnsZones-remove$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:consumerNetwork string, :name string}
Service producers can use this method to remove private DNS zones in the shared producer host project and matching peering zones in the consumer project.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/dnsZones/remove Required parameters: parent Optional parameters: none Body: {:consumerNetwork string, :name string} Service producers can use this method to remove private DNS zones in the shared producer host project and matching peering zones in the consumer project.
(enableVpcServiceControls$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:consumerNetwork string}
Enables VPC service controls for a connection.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/enableVpcServiceControls Required parameters: parent Optional parameters: none Body: {:consumerNetwork string} Enables VPC service controls for a connection.
(projects-global-networks-dnsZones-get$ auth parameters)
Required parameters: name
Optional parameters: none
Service producers can use this method to retrieve a DNS zone in the shared producer host project and the matching peering zones in consumer project
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/projects/global/networks/dnsZones/get Required parameters: name Optional parameters: none Service producers can use this method to retrieve a DNS zone in the shared producer host project and the matching peering zones in consumer project
(projects-global-networks-dnsZones-list$ auth parameters)
Required parameters: parent
Optional parameters: none
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/projects/global/networks/dnsZones/list Required parameters: parent Optional parameters: none * Service producers can use this method to retrieve a list of available DNS zones in the shared producer host project and the matching peering zones in the consumer project. *
(projects-global-networks-get$ auth parameters)
Required parameters: name
Optional parameters: includeUsedIpRanges
Service producers use this method to get the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/projects/global/networks/get Required parameters: name Optional parameters: includeUsedIpRanges Service producers use this method to get the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.
(projects-global-networks-getVpcServiceControls$ auth parameters)
Required parameters: name
Optional parameters: none
Consumers use this method to find out the state of VPC Service Controls. The controls could be enabled or disabled for a connection.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/projects/global/networks/getVpcServiceControls Required parameters: name Optional parameters: none Consumers use this method to find out the state of VPC Service Controls. The controls could be enabled or disabled for a connection.
(projects-global-networks-peeredDnsDomains-create$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:dnsSuffix string, :name string}
Creates a peered DNS domain which sends requests for records in given namespace originating in the service producer VPC network to the consumer VPC network to be resolved.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/projects/global/networks/peeredDnsDomains/create Required parameters: parent Optional parameters: none Body: {:dnsSuffix string, :name string} Creates a peered DNS domain which sends requests for records in given namespace originating in the service producer VPC network to the consumer VPC network to be resolved.
(projects-global-networks-peeredDnsDomains-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a peered DNS domain.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/projects/global/networks/peeredDnsDomains/delete Required parameters: name Optional parameters: none Deletes a peered DNS domain.
(projects-global-networks-peeredDnsDomains-list$ auth parameters)
Required parameters: parent
Optional parameters: none
Lists peered DNS domains for a connection.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/projects/global/networks/peeredDnsDomains/list Required parameters: parent Optional parameters: none Lists peered DNS domains for a connection.
(projects-global-networks-updateConsumerConfig$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:consumerConfig {:producerExportCustomRoutes boolean, :producerImportSubnetRoutesWithPublicIp boolean, :cloudsqlConfigs [CloudSQLConfig], :producerNetwork string, :consumerExportCustomRoutes boolean, :producerExportSubnetRoutesWithPublicIp boolean, :reservedRanges [GoogleCloudServicenetworkingV1ConsumerConfigReservedRange], :vpcScReferenceArchitectureEnabled boolean, :consumerImportSubnetRoutesWithPublicIp boolean, :usedIpRanges [string], :consumerImportCustomRoutes boolean, :consumerExportSubnetRoutesWithPublicIp boolean, :producerImportCustomRoutes boolean}}
Service producers use this method to update the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/projects/global/networks/updateConsumerConfig Required parameters: parent Optional parameters: none Body: {:consumerConfig {:producerExportCustomRoutes boolean, :producerImportSubnetRoutesWithPublicIp boolean, :cloudsqlConfigs [CloudSQLConfig], :producerNetwork string, :consumerExportCustomRoutes boolean, :producerExportSubnetRoutesWithPublicIp boolean, :reservedRanges [GoogleCloudServicenetworkingV1ConsumerConfigReservedRange], :vpcScReferenceArchitectureEnabled boolean, :consumerImportSubnetRoutesWithPublicIp boolean, :usedIpRanges [string], :consumerImportCustomRoutes boolean, :consumerExportSubnetRoutesWithPublicIp boolean, :producerImportCustomRoutes boolean}} Service producers use this method to update the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.
(roles-add$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:policyBinding [{:member string, :role string}], :consumerNetwork string}
Service producers can use this method to add roles in the shared VPC host project. Each role is bound to the provided member. Each role must be selected from within an allowlisted set of roles. Each role is applied at only the granularity specified in the allowlist.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/roles/add Required parameters: parent Optional parameters: none Body: {:policyBinding [{:member string, :role string}], :consumerNetwork string} Service producers can use this method to add roles in the shared VPC host project. Each role is bound to the provided member. Each role must be selected from within an allowlisted set of roles. Each role is applied at only the granularity specified in the allowlist.
(searchRange$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:ipPrefixLength integer, :network string}
Service producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not guaranteed to remain unused. It will validate previously provided allocated ranges, find non-conflicting sub-range of requested size (expressed in number of leading bits of ipv4 network mask, as in CIDR range notation).
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/searchRange Required parameters: parent Optional parameters: none Body: {:ipPrefixLength integer, :network string} Service producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not guaranteed to remain unused. It will validate previously provided allocated ranges, find non-conflicting sub-range of requested size (expressed in number of leading bits of ipv4 network mask, as in CIDR range notation).
(validate$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:rangeReservation {:secondaryRangeIpPrefixLengths [integer], :ipPrefixLength integer, :requestedRanges [string], :subnetworkCandidates [Subnetwork]}, :validateNetwork boolean, :checkServiceNetworkingUsePermission boolean, :consumerProject {:projectNum string}, :consumerNetwork string}
Service producers use this method to validate if the consumer provided network, project and requested range are valid. This allows them to use a fail-fast mechanism for consumer requests, and not have to wait for AddSubnetwork operation completion to determine if user request is invalid.
https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/validate Required parameters: parent Optional parameters: none Body: {:rangeReservation {:secondaryRangeIpPrefixLengths [integer], :ipPrefixLength integer, :requestedRanges [string], :subnetworkCandidates [Subnetwork]}, :validateNetwork boolean, :checkServiceNetworkingUsePermission boolean, :consumerProject {:projectNum string}, :consumerNetwork string} Service producers use this method to validate if the consumer provided network, project and requested range are valid. This allows them to use a fail-fast mechanism for consumer requests, and not have to wait for AddSubnetwork operation completion to determine if user request is invalid.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close