google_api_service_networking

v0.10.0

google_api_service_networking v0.10.0 GoogleApi.ServiceNetworking.V1.Api.Services View Source

API calls for all endpoints tagged Services.

Link to this section 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_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_enable_vpc_service_controls(connection, parent, optional_params \\ [], opts \\ [])

Enables VPC service controls for a connection.

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 a whitelisted set of roles. Each role is applied at only the granularity specified in the whitelist.

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.

Link to this section Functions

Link to this function

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

View Source 
servicenetworking_services_add_subnetwork(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

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

View Source 
servicenetworking_services_connections_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

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

View Source 
servicenetworking_services_connections_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.ListConnectionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

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

View Source 
servicenetworking_services_connections_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

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

View Source 
servicenetworking_services_disable_vpc_service_controls(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

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

View Source 
servicenetworking_services_enable_vpc_service_controls(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

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

View Source 
servicenetworking_services_roles_add(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {: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 a whitelisted set of roles. Each role is applied at only the granularity specified in the whitelist.

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
Link to this function

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

View Source 
servicenetworking_services_search_range(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {: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
Link to this function

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

View Source 
servicenetworking_services_validate(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceNetworking.V1.Model.ValidateConsumerConfigResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {: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