ServiceNetworking

import { ServiceNetworking } from "https://googleapis.deno.dev/v1/servicenetworking:v1.ts";

Provides automatic management of network configurations necessary for certain services.

class ServiceNetworking {

constructor(client?: CredentialsClient, baseUrl?: string);

async operationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async operationsDelete(name: string): Promise<Empty>;

async operationsGet(name: string): Promise<Operation>;

async operationsList(name: string, opts?: OperationsListOptions): Promise<ListOperationsResponse>;

async servicesAddSubnetwork(parent: string, req: AddSubnetworkRequest): Promise<Operation>;

async servicesConnectionsCreate(parent: string, req: Connection): Promise<Operation>;

async servicesConnectionsDeleteConnection(name: string, req: DeleteConnectionRequest): Promise<Operation>;

async servicesConnectionsList(parent: string, opts?: ServicesConnectionsListOptions): Promise<ListConnectionsResponse>;

async servicesConnectionsPatch(

name: string,

req: Connection,

opts?: ServicesConnectionsPatchOptions,

): Promise<Operation>;

async servicesDisableVpcServiceControls(parent: string, req: DisableVpcServiceControlsRequest): Promise<Operation>;

async servicesDnsRecordSetsAdd(parent: string, req: AddDnsRecordSetRequest): Promise<Operation>;

async servicesDnsRecordSetsGet(parent: string, opts?: ServicesDnsRecordSetsGetOptions): Promise<DnsRecordSet>;

async servicesDnsRecordSetsList(parent: string, opts?: ServicesDnsRecordSetsListOptions): Promise<ListDnsRecordSetsResponse>;

async servicesDnsRecordSetsRemove(parent: string, req: RemoveDnsRecordSetRequest): Promise<Operation>;

async servicesDnsRecordSetsUpdate(parent: string, req: UpdateDnsRecordSetRequest): Promise<Operation>;

async servicesDnsZonesAdd(parent: string, req: AddDnsZoneRequest): Promise<Operation>;

async servicesDnsZonesRemove(parent: string, req: RemoveDnsZoneRequest): Promise<Operation>;

async servicesEnableVpcServiceControls(parent: string, req: EnableVpcServiceControlsRequest): Promise<Operation>;

async servicesProjectsGlobalNetworksDnsZonesGet(name: string): Promise<GetDnsZoneResponse>;

async servicesProjectsGlobalNetworksDnsZonesList(parent: string): Promise<ListDnsZonesResponse>;

async servicesProjectsGlobalNetworksGet(name: string, opts?: ServicesProjectsGlobalNetworksGetOptions): Promise<ConsumerConfig>;

async servicesProjectsGlobalNetworksGetVpcServiceControls(name: string): Promise<VpcServiceControls>;

async servicesProjectsGlobalNetworksPeeredDnsDomainsCreate(parent: string, req: PeeredDnsDomain): Promise<Operation>;

async servicesProjectsGlobalNetworksPeeredDnsDomainsDelete(name: string): Promise<Operation>;

async servicesProjectsGlobalNetworksPeeredDnsDomainsList(parent: string): Promise<ListPeeredDnsDomainsResponse>;

async servicesProjectsGlobalNetworksUpdateConsumerConfig(parent: string, req: UpdateConsumerConfigRequest): Promise<Operation>;

async servicesRolesAdd(parent: string, req: AddRolesRequest): Promise<Operation>;

async servicesSearchRange(parent: string, req: SearchRangeRequest): Promise<Operation>;

async servicesValidate(parent: string, req: ValidateConsumerConfigRequest): Promise<ValidateConsumerConfigResponse>;

}

§Constructors

new ServiceNetworking(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

operationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

operationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

operationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

operationsList(name: string, opts?: OperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

servicesAddSubnetwork(parent: string, req: AddSubnetworkRequest): Promise<Operation>

[src]

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.

@param parent

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.

servicesConnectionsCreate(parent: string, req: Connection): Promise<Operation>

[src]

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.

@param parent

servicesConnectionsDeleteConnection(name: string, req: DeleteConnectionRequest): Promise<Operation>

[src]

Deletes a private service access connection.

@param name

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.

servicesConnectionsList(parent: string, opts?: ServicesConnectionsListOptions): Promise<ListConnectionsResponse>

[src]

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

@param parent

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.

servicesConnectionsPatch(name: string, req: Connection, opts?: ServicesConnectionsPatchOptions): Promise<Operation>

[src]

Updates the allocated ranges that are assigned to a connection.

@param name

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.

servicesDisableVpcServiceControls(parent: string, req: DisableVpcServiceControlsRequest): Promise<Operation>

[src]

Disables VPC service controls for a connection.

@param parent

servicesDnsRecordSetsAdd(parent: string, req: AddDnsRecordSetRequest): Promise<Operation>

[src]

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

@param parent

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.

servicesDnsRecordSetsGet(parent: string, opts?: ServicesDnsRecordSetsGetOptions): Promise<DnsRecordSet>

[src]

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.

@param parent

Required. Parent resource identifying the connection which owns this collection of DNS zones in the format services/{service}.

servicesDnsRecordSetsList(parent: string, opts?: ServicesDnsRecordSetsListOptions): Promise<ListDnsRecordSetsResponse>

[src]

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.

@param parent

servicesDnsRecordSetsRemove(parent: string, req: RemoveDnsRecordSetRequest): Promise<Operation>

[src]

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

@param parent

servicesDnsRecordSetsUpdate(parent: string, req: UpdateDnsRecordSetRequest): Promise<Operation>

[src]

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

@param parent

servicesDnsZonesAdd(parent: string, req: AddDnsZoneRequest): Promise<Operation>

[src]

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.

@param parent

servicesDnsZonesRemove(parent: string, req: RemoveDnsZoneRequest): Promise<Operation>

[src]

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.

@param parent

servicesEnableVpcServiceControls(parent: string, req: EnableVpcServiceControlsRequest): Promise<Operation>

[src]

Enables VPC service controls for a connection.

@param parent

servicesProjectsGlobalNetworksDnsZonesGet(name: string): Promise<GetDnsZoneResponse>

[src]

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

@param name

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}/zones/{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

servicesProjectsGlobalNetworksDnsZonesList(parent: string): Promise<ListDnsZonesResponse>

[src]

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

@param parent

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.

servicesProjectsGlobalNetworksGet(name: string, opts?: ServicesProjectsGlobalNetworksGetOptions): Promise<ConsumerConfig>

[src]

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.

@param name

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.

servicesProjectsGlobalNetworksGetVpcServiceControls(name: string): Promise<VpcServiceControls>

[src]

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

@param name

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.

servicesProjectsGlobalNetworksPeeredDnsDomainsCreate(parent: string, req: PeeredDnsDomain): Promise<Operation>

[src]

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.

@param parent

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.

servicesProjectsGlobalNetworksPeeredDnsDomainsDelete(name: string): Promise<Operation>

[src]

Deletes a peered DNS domain.

@param name

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.

servicesProjectsGlobalNetworksPeeredDnsDomainsList(parent: string): Promise<ListPeeredDnsDomainsResponse>

[src]

Lists peered DNS domains for a connection.

@param parent

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.

servicesProjectsGlobalNetworksUpdateConsumerConfig(parent: string, req: UpdateConsumerConfigRequest): Promise<Operation>

[src]

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.

@param parent

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.

servicesRolesAdd(parent: string, req: AddRolesRequest): Promise<Operation>

[src]

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.

@param parent

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

servicesSearchRange(parent: string, req: SearchRangeRequest): Promise<Operation>

[src]

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

@param parent

Required. This is in a form services/{service}. {service} the name of the private access management service, for example 'service-peering.example.com'.

servicesValidate(parent: string, req: ValidateConsumerConfigRequest): Promise<ValidateConsumerConfigResponse>

[src]

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.

@param parent

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