GoogleApi.ServiceNetworking.V1.Api.Services (google_api_service_networking v0.40.0)

View Source

API calls for all endpoints tagged Services.

Summary

Functions

servicenetworking_services_add_subnetwork(connection, parent, optional_params \\ [], opts \\ [])

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.

servicenetworking_services_connections_create(connection, parent, optional_params \\ [], opts \\ [])

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.

servicenetworking_services_connections_delete_connection(connection, name, optional_params \\ [], opts \\ [])

Deletes a private service access connection.

servicenetworking_services_connections_list(connection, parent, optional_params \\ [], opts \\ [])

List the private connections that are configured in a service consumer's VPC network.

servicenetworking_services_connections_patch(connection, name, optional_params \\ [], opts \\ [])

Updates the allocated ranges that are assigned to a connection.

servicenetworking_services_disable_vpc_service_controls(connection, parent, optional_params \\ [], opts \\ [])

Disables VPC service controls for a connection.

servicenetworking_services_dns_record_sets_add(connection, parent, optional_params \\ [], opts \\ [])

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

servicenetworking_services_dns_record_sets_get(connection, parent, optional_params \\ [], opts \\ [])

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.

servicenetworking_services_dns_record_sets_list(connection, parent, optional_params \\ [], opts \\ [])

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.

servicenetworking_services_dns_record_sets_remove(connection, parent, optional_params \\ [], opts \\ [])

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

servicenetworking_services_dns_record_sets_update(connection, parent, optional_params \\ [], opts \\ [])

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

servicenetworking_services_dns_zones_add(connection, parent, optional_params \\ [], opts \\ [])

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.

servicenetworking_services_dns_zones_remove(connection, parent, optional_params \\ [], opts \\ [])

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.

servicenetworking_services_enable_vpc_service_controls(connection, parent, optional_params \\ [], opts \\ [])

Enables VPC service controls for a connection.

servicenetworking_services_projects_global_networks_dns_zones_get(connection, name, optional_params \\ [], opts \\ [])

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

servicenetworking_services_projects_global_networks_dns_zones_list(connection, parent, optional_params \\ [], opts \\ [])
  • 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. *

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Parent resource identifying the connection which owns this collection of DNS zones in the format services/{service}/projects/{project}/global/networks/{network} Service: The service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is servicenetworking.googleapis.com. Projects: the consumer project containing the consumer network. Network: The consumer network accessible from the tenant project.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.ListDnsZonesResponse{}} on success
  • {:error, info} on failure
servicenetworking_services_projects_global_networks_get(connection, name, optional_params \\ [], opts \\ [])

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.

servicenetworking_services_projects_global_networks_get_vpc_service_controls(connection, name, optional_params \\ [], opts \\ [])

Consumers use this method to find out the state of VPC Service Controls. The controls could be enabled or disabled for a connection.

servicenetworking_services_projects_global_networks_peered_dns_domains_create(connection, parent, optional_params \\ [], opts \\ [])

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.

servicenetworking_services_projects_global_networks_peered_dns_domains_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a peered DNS domain.

servicenetworking_services_projects_global_networks_peered_dns_domains_list(connection, parent, optional_params \\ [], opts \\ [])

Lists peered DNS domains for a connection.

servicenetworking_services_projects_global_networks_update_consumer_config(connection, parent, optional_params \\ [], opts \\ [])

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.

servicenetworking_services_roles_add(connection, parent, optional_params \\ [], opts \\ [])

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.

servicenetworking_services_search_range(connection, parent, optional_params \\ [], opts \\ [])

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

servicenetworking_services_validate(connection, parent, optional_params \\ [], opts \\ [])

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.

Functions

servicenetworking_services_add_subnetwork(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_add_subnetwork(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. A tenant project in the service producer organization, in the following format: services/{service}/{collection-id}/{resource-id}. {collection-id} is the cloud resource collection type that represents the tenant project. Only projects are supported. {resource-id} is the tenant project numeric id, such as 123456. {service} the name of the peering service, such as service-peering.example.com. This service must already be enabled in the service consumer's project.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.AddSubnetworkRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_connections_create(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_connections_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.Connection.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_connections_delete_connection(connection, name, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_connections_delete_connection(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a private service access connection.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of services/{peering_service_name}/connections/{vpc_peering_name}. For Google services that support this functionality, this is services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.DeleteConnectionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_connections_list(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_connections_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.ListConnectionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List the private connections that are configured in a service consumer's VPC network.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com. If you specify services/- as the parameter value, all configured peering services are listed.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :network (type: String.t) - The name of service consumer's VPC network that's connected with service producer network through a private connection. The network name must be in the following format: projects/{project}/global/networks/{network}. {project} is a project number, such as in 12345 that includes the VPC service consumer's VPC network. {network} is the name of the service consumer's VPC network.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.ListConnectionsResponse{}} on success
  • {:error, info} on failure

servicenetworking_services_connections_patch(connection, name, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_connections_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the allocated ranges that are assigned to a connection.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • name (type: String.t) - The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of services/{peering_service_name}/connections/{vpc_peering_name}. For Google services that support this functionality, this is services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :force (type: boolean()) - If a previously defined allocated range is removed, force flag must be set to true.
    • :updateMask (type: String.t) - The update mask. If this is omitted, it defaults to "*". You can only update the listed peering ranges.
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.Connection.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_disable_vpc_service_controls(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_disable_vpc_service_controls(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Disables VPC service controls for a connection.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.DisableVpcServiceControlsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_dns_record_sets_add(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_dns_record_sets_add(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.AddDnsRecordSetRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_dns_record_sets_get(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_dns_record_sets_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.DnsRecordSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Parent resource identifying the connection which owns this collection of DNS zones in the format services/{service}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :consumerNetwork (type: String.t) - Required. The consumer network containing the record set. Must be in the form of projects/{project}/global/networks/{network}
    • :domain (type: String.t) - Required. The domain name of the zone containing the recordset.
    • :type (type: String.t) - Required. RecordSet Type eg. type='A'. See the list of Supported DNS Types.
    • :zone (type: String.t) - Required. The name of the zone containing the record set.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.DnsRecordSet{}} on success
  • {:error, info} on failure

servicenetworking_services_dns_record_sets_list(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_dns_record_sets_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.ListDnsRecordSetsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :consumerNetwork (type: String.t) - Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is the project number, as in '12345' {network} is the network name.
    • :zone (type: String.t) - Required. The name of the private DNS zone in the shared producer host project from which the record set will be removed.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.ListDnsRecordSetsResponse{}} on success
  • {:error, info} on failure

servicenetworking_services_dns_record_sets_remove(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_dns_record_sets_remove(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.RemoveDnsRecordSetRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_dns_record_sets_update(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_dns_record_sets_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.UpdateDnsRecordSetRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_dns_zones_add(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_dns_zones_add(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.AddDnsZoneRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_dns_zones_remove(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_dns_zones_remove(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.RemoveDnsZoneRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_enable_vpc_service_controls(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_enable_vpc_service_controls(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Enables VPC service controls for a connection.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.EnableVpcServiceControlsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_projects_global_networks_dns_zones_get(connection, name, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_projects_global_networks_dns_zones_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.GetDnsZoneResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The network that the consumer is using to connect with services. Must be in the form of services/{service}/projects/{project}/global/networks/{network}/dnsZones/{zoneName} Where {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this {project} is the project number, as in '12345' {network} is the network name. {zoneName} is the DNS zone name
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.GetDnsZoneResponse{}} on success
  • {:error, info} on failure

servicenetworking_services_projects_global_networks_dns_zones_list(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_projects_global_networks_dns_zones_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.ListDnsZonesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}
  • 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. *

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Parent resource identifying the connection which owns this collection of DNS zones in the format services/{service}/projects/{project}/global/networks/{network} Service: The service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is servicenetworking.googleapis.com. Projects: the consumer project containing the consumer network. Network: The consumer network accessible from the tenant project.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.ListDnsZonesResponse{}} on success
  • {:error, info} on failure

servicenetworking_services_projects_global_networks_get(connection, name, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_projects_global_networks_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.ConsumerConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the consumer config to retrieve in the format: services/{service}/projects/{project}/global/networks/{network}. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is servicenetworking.googleapis.com. {project} is a project number e.g. 12345 that contains the service consumer's VPC network. {network} is the name of the service consumer's VPC network.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :includeUsedIpRanges (type: boolean()) - Optional. When true, include the used IP ranges as part of the GetConsumerConfig output. This includes routes created inside the service networking network, consumer network, peers of the consumer network, and reserved ranges inside the service networking network. By default, this is false
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.ConsumerConfig{}} on success
  • {:error, info} on failure

servicenetworking_services_projects_global_networks_get_vpc_service_controls(connection, name, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_projects_global_networks_get_vpc_service_controls(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.VpcServiceControls.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Consumers use this method to find out the state of VPC Service Controls. The controls could be enabled or disabled for a connection.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the VPC Service Controls config to retrieve in the format: services/{service}/projects/{project}/global/networks/{network}. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is servicenetworking.googleapis.com. {project} is a project number e.g. 12345 that contains the service consumer's VPC network. {network} is the name of the service consumer's VPC network.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.VpcServiceControls{}} on success
  • {:error, info} on failure

servicenetworking_services_projects_global_networks_peered_dns_domains_create(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_projects_global_networks_peered_dns_domains_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Parent resource identifying the connection for which the peered DNS domain will be created in the format: services/{service}/projects/{project}/global/networks/{network} {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is servicenetworking.googleapis.com. {project} is the number of the project that contains the service consumer's VPC network e.g. 12345. {network} is the name of the service consumer's VPC network.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.PeeredDnsDomain.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_projects_global_networks_peered_dns_domains_delete(connection, name, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_projects_global_networks_peered_dns_domains_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a peered DNS domain.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the peered DNS domain to delete in the format: services/{service}/projects/{project}/global/networks/{network}/peeredDnsDomains/{name}. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is servicenetworking.googleapis.com. {project} is the number of the project that contains the service consumer's VPC network e.g. 12345. {network} is the name of the service consumer's VPC network. {name} is the name of the peered DNS domain.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_projects_global_networks_peered_dns_domains_list(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_projects_global_networks_peered_dns_domains_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.ListPeeredDnsDomainsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists peered DNS domains for a connection.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Parent resource identifying the connection which owns this collection of peered DNS domains in the format: services/{service}/projects/{project}/global/networks/{network}. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is servicenetworking.googleapis.com. {project} is a project number e.g. 12345 that contains the service consumer's VPC network. {network} is the name of the service consumer's VPC network.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.ListPeeredDnsDomainsResponse{}} on success
  • {:error, info} on failure

servicenetworking_services_projects_global_networks_update_consumer_config(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_projects_global_networks_update_consumer_config(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Parent resource identifying the connection for which the consumer config is being updated in the format: services/{service}/projects/{project}/global/networks/{network} {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is servicenetworking.googleapis.com. {project} is the number of the project that contains the service consumer's VPC network e.g. 12345. {network} is the name of the service consumer's VPC network.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.UpdateConsumerConfigRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_roles_add(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_roles_add(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. This is in a form services/{service} where {service} is the name of the private access management service. For example 'service-peering.example.com'.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.AddRolesRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_search_range(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_search_range(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. This is in a form services/{service}. {service} the name of the private access management service, for example 'service-peering.example.com'.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.SearchRangeRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.Operation{}} on success
  • {:error, info} on failure

servicenetworking_services_validate(connection, parent, optional_params \\ [], opts \\ [])

@spec servicenetworking_services_validate(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.ValidateConsumerConfigResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.ServiceNetworking.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. This is in a form services/{service} where {service} is the name of the private access management service. For example 'service-peering.example.com'.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.ServiceNetworking.V1.Model.ValidateConsumerConfigRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ServiceNetworking.V1.Model.ValidateConsumerConfigResponse{}} on success
  • {:error, info} on failure