Liking cljdoc? Tell your friends :D

happygapi.servicenetworking.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

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
raw docstring

addSubnetwork$clj

(addSubnetwork$ auth parameters body)

https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/addSubnetwork

Required parameters: parent

Optional parameters: none

Body:

{:description string, :consumer string, :consumerNetwork string, :privateIpv6GoogleAccess string, :subnetworkUsers [string], :outsideAllocationPublicIpRange string, :requestedAddress string, :region string, :ipPrefixLength integer, :requestedRanges [string], :secondaryIpRangeSpecs [{:rangeName string, :ipPrefixLength integer, :requestedAddress 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: 

{:description string,
 :consumer string,
 :consumerNetwork string,
 :privateIpv6GoogleAccess string,
 :subnetworkUsers [string],
 :outsideAllocationPublicIpRange string,
 :requestedAddress string,
 :region string,
 :ipPrefixLength integer,
 :requestedRanges [string],
 :secondaryIpRangeSpecs [{:rangeName string,
                          :ipPrefixLength integer,
                          :requestedAddress 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.
sourceraw docstring

connections-create$clj

(connections-create$ auth parameters body)

https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/connections/create

Required parameters: parent

Optional parameters: none

Body:

{:service string, :peering 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: 

{:service string,
 :peering 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.
sourceraw docstring

connections-deleteConnection$clj

(connections-deleteConnection$ auth parameters body)

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.

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.
sourceraw docstring

connections-list$clj

(connections-list$ auth parameters)

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.

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.
sourceraw docstring

connections-patch$clj

(connections-patch$ auth parameters body)

https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/connections/patch

Required parameters: name

Optional parameters: force, updateMask

Body:

{:service string, :peering 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: force, updateMask

Body: 

{:service string,
 :peering string,
 :reservedPeeringRanges [string],
 :network string}

Updates the allocated ranges that are assigned to a connection.
sourceraw docstring

disableVpcServiceControls$clj

(disableVpcServiceControls$ auth parameters body)

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.

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.
sourceraw docstring

dnsRecordSets-add$clj

(dnsRecordSets-add$ auth parameters body)

https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/dnsRecordSets/add

Required parameters: parent

Optional parameters: none

Body:

{:consumerNetwork string, :zone string, :dnsRecordSet {:ttl string, :type string, :data [string], :domain 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: 

{:consumerNetwork string,
 :zone string,
 :dnsRecordSet {:ttl string,
                :type string,
                :data [string],
                :domain string}}

Service producers can use this method to add DNS record sets to private DNS zones in the shared producer host project.
sourceraw docstring

dnsRecordSets-remove$clj

(dnsRecordSets-remove$ auth parameters body)

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 {:ttl string, :type string, :data [string], :domain 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 {:ttl string,
                :type string,
                :data [string],
                :domain 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.
sourceraw docstring

dnsRecordSets-update$clj

(dnsRecordSets-update$ auth parameters body)

https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/dnsRecordSets/update

Required parameters: parent

Optional parameters: none

Body:

{:existingDnsRecordSet {:ttl string, :type string, :data [string], :domain string}, :consumerNetwork string, :zone string, :newDnsRecordSet {:ttl string, :type string, :data [string], :domain 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: 

{:existingDnsRecordSet {:ttl string,
                        :type string,
                        :data [string],
                        :domain string},
 :consumerNetwork string,
 :zone string,
 :newDnsRecordSet {:ttl string,
                   :type string,
                   :data [string],
                   :domain string}}

Service producers can use this method to update DNS record sets from private DNS zones in the shared producer host project.
sourceraw docstring

dnsZones-add$clj

(dnsZones-add$ auth parameters body)

https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/dnsZones/add

Required parameters: parent

Optional parameters: none

Body:

{:consumerNetwork string, :name string, :dnsSuffix 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: 

{:consumerNetwork string, :name string, :dnsSuffix 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.
sourceraw docstring

dnsZones-remove$clj

(dnsZones-remove$ auth parameters body)

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.

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.
sourceraw docstring

enableVpcServiceControls$clj

(enableVpcServiceControls$ auth parameters body)

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.

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.
sourceraw docstring

projects-global-networks-get$clj

(projects-global-networks-get$ auth parameters)

https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/projects/global/networks/get

Required parameters: name

Optional parameters: none

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: none

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.
sourceraw docstring

projects-global-networks-peeredDnsDomains-create$clj

(projects-global-networks-peeredDnsDomains-create$ auth parameters body)

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:

{:name string, :dnsSuffix 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: 

{:name string, :dnsSuffix 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.
sourceraw docstring

projects-global-networks-peeredDnsDomains-delete$clj

(projects-global-networks-peeredDnsDomains-delete$ auth parameters)
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.
sourceraw docstring

projects-global-networks-peeredDnsDomains-list$clj

(projects-global-networks-peeredDnsDomains-list$ auth parameters)
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.
sourceraw docstring

projects-global-networks-updateConsumerConfig$clj

(projects-global-networks-updateConsumerConfig$ auth parameters body)

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, :producerNetwork string, :consumerExportCustomRoutes boolean, :producerExportSubnetRoutesWithPublicIp boolean, :reservedRanges [GoogleCloudServicenetworkingV1ConsumerConfigReservedRange], :vpcScReferenceArchitectureEnabled boolean, :consumerImportSubnetRoutesWithPublicIp boolean, :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,
                  :producerNetwork string,
                  :consumerExportCustomRoutes boolean,
                  :producerExportSubnetRoutesWithPublicIp boolean,
                  :reservedRanges [GoogleCloudServicenetworkingV1ConsumerConfigReservedRange],
                  :vpcScReferenceArchitectureEnabled boolean,
                  :consumerImportSubnetRoutesWithPublicIp boolean,
                  :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.
sourceraw docstring

roles-add$clj

(roles-add$ auth parameters body)

https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/roles/add

Required parameters: parent

Optional parameters: none

Body:

{:consumerNetwork string, :policyBinding [{:role string, :member 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: 

{:consumerNetwork string,
 :policyBinding [{:role string, :member 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.
sourceraw docstring

searchRange$clj

(searchRange$ auth parameters body)

https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/searchRange

Required parameters: parent

Optional parameters: none

Body:

{:network string, :ipPrefixLength integer}

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: 

{:network string, :ipPrefixLength integer}

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).
sourceraw docstring

validate$clj

(validate$ auth parameters body)

https://cloud.google.com/service-infrastructure/docs/service-networking/getting-startedapi/reference/rest/v1/services/validate

Required parameters: parent

Optional parameters: none

Body:

{:rangeReservation {:ipPrefixLength integer, :secondaryRangeIpPrefixLengths [integer], :requestedRanges [string], :subnetworkCandidates [Subnetwork]}, :validateNetwork 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 {:ipPrefixLength integer,
                    :secondaryRangeIpPrefixLengths [integer],
                    :requestedRanges [string],
                    :subnetworkCandidates [Subnetwork]},
 :validateNetwork 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.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close