Class NetworkService

constructor

• new NetworkService(sdk: SDKInterface): NetworkService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns NetworkService

$type

create

• create(
      request: CreateNetworkRequest,
  ): Request<CreateNetworkRequest, Operation<GetOperationRequest>>

  Creates a new network with the specified configuration.

  Parameters

  • request: CreateNetworkRequest

  Returns Request<CreateNetworkRequest, Operation<GetOperationRequest>>

• create(
      request: CreateNetworkRequest,
      metadata: Metadata,
  ): Request<CreateNetworkRequest, Operation<GetOperationRequest>>

  Creates a new network with the specified configuration.

  Parameters

  • request: CreateNetworkRequest
  • metadata: Metadata

  Returns Request<CreateNetworkRequest, Operation<GetOperationRequest>>

• create(
      request: CreateNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateNetworkRequest, Operation<GetOperationRequest>>

  Creates a new network with the specified configuration.

  Parameters

  • request: CreateNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateNetworkRequest, Operation<GetOperationRequest>>

• create(
      request: CreateNetworkRequest,
  ): Request<CreateNetworkRequest, Operation<GetOperationRequest>>

  Creates a new network with the specified configuration.

  Parameters

  • request: CreateNetworkRequest

  Returns Request<CreateNetworkRequest, Operation<GetOperationRequest>>

• create(
      request: CreateNetworkRequest,
      metadata: Metadata,
  ): Request<CreateNetworkRequest, Operation<GetOperationRequest>>

  Creates a new network with the specified configuration.

  Parameters

  • request: CreateNetworkRequest
  • metadata: Metadata

  Returns Request<CreateNetworkRequest, Operation<GetOperationRequest>>

• create(
      request: CreateNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateNetworkRequest, Operation<GetOperationRequest>>

  Creates a new network with the specified configuration.

  Parameters

  • request: CreateNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateNetworkRequest, Operation<GetOperationRequest>>

createDefault

• createDefault(
      request: CreateDefaultNetworkRequest,
  ): Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

  Creates a default network, subnet, pools, and route table for a specified project. Creates a default security group when that feature is enabled for the project.

  Parameters

  • request: CreateDefaultNetworkRequest

  Returns Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

• createDefault(
      request: CreateDefaultNetworkRequest,
      metadata: Metadata,
  ): Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

  Creates a default network, subnet, pools, and route table for a specified project. Creates a default security group when that feature is enabled for the project.

  Parameters

  • request: CreateDefaultNetworkRequest
  • metadata: Metadata

  Returns Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

• createDefault(
      request: CreateDefaultNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

  Creates a default network, subnet, pools, and route table for a specified project. Creates a default security group when that feature is enabled for the project.

  Parameters

  • request: CreateDefaultNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

• createDefault(
      request: CreateDefaultNetworkRequest,
  ): Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

  Creates a default network, subnet, pools, and route table for a specified project. Creates a default security group when that feature is enabled for the project.

  Parameters

  • request: CreateDefaultNetworkRequest

  Returns Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

• createDefault(
      request: CreateDefaultNetworkRequest,
      metadata: Metadata,
  ): Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

  Creates a default network, subnet, pools, and route table for a specified project. Creates a default security group when that feature is enabled for the project.

  Parameters

  • request: CreateDefaultNetworkRequest
  • metadata: Metadata

  Returns Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

• createDefault(
      request: CreateDefaultNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

  Creates a default network, subnet, pools, and route table for a specified project. Creates a default security group when that feature is enabled for the project.

  Parameters

  • request: CreateDefaultNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateDefaultNetworkRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteNetworkRequest,
  ): Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

  Deletes a network by its ID.

  Parameters

  • request: DeleteNetworkRequest

  Returns Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteNetworkRequest,
      metadata: Metadata,
  ): Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

  Deletes a network by its ID.

  Parameters

  • request: DeleteNetworkRequest
  • metadata: Metadata

  Returns Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

  Deletes a network by its ID.

  Parameters

  • request: DeleteNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteNetworkRequest,
  ): Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

  Deletes a network by its ID.

  Parameters

  • request: DeleteNetworkRequest

  Returns Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteNetworkRequest,
      metadata: Metadata,
  ): Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

  Deletes a network by its ID.

  Parameters

  • request: DeleteNetworkRequest
  • metadata: Metadata

  Returns Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

  Deletes a network by its ID.

  Parameters

  • request: DeleteNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteNetworkRequest, Operation<GetOperationRequest>>

filter

• filter(
      request: ListNetworksRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Network>

  Calls the filter method.

  Parameters

  • request: ListNetworksRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Network>

• filter(
      request: ListNetworksRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Network>

  Yields list items across pages, without changing the supplied request.

  Parameters

  • request: ListNetworksRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Network>

get

• get(request: GetNetworkRequest): Request<GetNetworkRequest, Network>

  Retrieves a network by its ID.

  Parameters

  • request: GetNetworkRequest

  Returns Request<GetNetworkRequest, Network>

• get(
      request: GetNetworkRequest,
      metadata: Metadata,
  ): Request<GetNetworkRequest, Network>

  Retrieves a network by its ID.

  Parameters

  • request: GetNetworkRequest
  • metadata: Metadata

  Returns Request<GetNetworkRequest, Network>

• get(
      request: GetNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetNetworkRequest, Network>

  Retrieves a network by its ID.

  Parameters

  • request: GetNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetNetworkRequest, Network>

• get(request: GetNetworkRequest): Request<GetNetworkRequest, Network>

  Retrieves a network by its ID.

  Parameters

  • request: GetNetworkRequest

  Returns Request<GetNetworkRequest, Network>

• get(
      request: GetNetworkRequest,
      metadata: Metadata,
  ): Request<GetNetworkRequest, Network>

  Retrieves a network by its ID.

  Parameters

  • request: GetNetworkRequest
  • metadata: Metadata

  Returns Request<GetNetworkRequest, Network>

• get(
      request: GetNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetNetworkRequest, Network>

  Retrieves a network by its ID.

  Parameters

  • request: GetNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetNetworkRequest, Network>

getByName

• getByName(
      request: GetNetworkByNameRequest,
  ): Request<GetNetworkByNameRequest, Network>

  Retrieves a network by its name within a specified parent.

  Parameters

  • request: GetNetworkByNameRequest

  Returns Request<GetNetworkByNameRequest, Network>

• getByName(
      request: GetNetworkByNameRequest,
      metadata: Metadata,
  ): Request<GetNetworkByNameRequest, Network>

  Retrieves a network by its name within a specified parent.

  Parameters

  • request: GetNetworkByNameRequest
  • metadata: Metadata

  Returns Request<GetNetworkByNameRequest, Network>

• getByName(
      request: GetNetworkByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetNetworkByNameRequest, Network>

  Retrieves a network by its name within a specified parent.

  Parameters

  • request: GetNetworkByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetNetworkByNameRequest, Network>

• getByName(
      request: GetNetworkByNameRequest,
  ): Request<GetNetworkByNameRequest, Network>

  Retrieves a network by its name within a specified parent.

  Parameters

  • request: GetNetworkByNameRequest

  Returns Request<GetNetworkByNameRequest, Network>

• getByName(
      request: GetNetworkByNameRequest,
      metadata: Metadata,
  ): Request<GetNetworkByNameRequest, Network>

  Retrieves a network by its name within a specified parent.

  Parameters

  • request: GetNetworkByNameRequest
  • metadata: Metadata

  Returns Request<GetNetworkByNameRequest, Network>

• getByName(
      request: GetNetworkByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetNetworkByNameRequest, Network>

  Retrieves a network by its name within a specified parent.

  Parameters

  • request: GetNetworkByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetNetworkByNameRequest, Network>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListNetworksRequest,
  ): Request<ListNetworksRequest, ListNetworksResponse>

  Lists networks within a specified parent.

  Parameters

  • request: ListNetworksRequest

  Returns Request<ListNetworksRequest, ListNetworksResponse>

• list(
      request: ListNetworksRequest,
      metadata: Metadata,
  ): Request<ListNetworksRequest, ListNetworksResponse>

  Lists networks within a specified parent.

  Parameters

  • request: ListNetworksRequest
  • metadata: Metadata

  Returns Request<ListNetworksRequest, ListNetworksResponse>

• list(
      request: ListNetworksRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListNetworksRequest, ListNetworksResponse>

  Lists networks within a specified parent.

  Parameters

  • request: ListNetworksRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListNetworksRequest, ListNetworksResponse>

• list(
      request: ListNetworksRequest,
  ): Request<ListNetworksRequest, ListNetworksResponse>

  Lists networks within a specified parent.

  Parameters

  • request: ListNetworksRequest

  Returns Request<ListNetworksRequest, ListNetworksResponse>

• list(
      request: ListNetworksRequest,
      metadata: Metadata,
  ): Request<ListNetworksRequest, ListNetworksResponse>

  Lists networks within a specified parent.

  Parameters

  • request: ListNetworksRequest
  • metadata: Metadata

  Returns Request<ListNetworksRequest, ListNetworksResponse>

• list(
      request: ListNetworksRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListNetworksRequest, ListNetworksResponse>

  Lists networks within a specified parent.

  Parameters

  • request: ListNetworksRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListNetworksRequest, ListNetworksResponse>

listAggregated

• listAggregated(
      request: ListAggregatedNetworksRequest,
  ): Request<ListAggregatedNetworksRequest, ListNetworksResponse>

  Lists networks across regions for the specified parent.

  Parameters

  • request: ListAggregatedNetworksRequest

  Returns Request<ListAggregatedNetworksRequest, ListNetworksResponse>

• listAggregated(
      request: ListAggregatedNetworksRequest,
      metadata: Metadata,
  ): Request<ListAggregatedNetworksRequest, ListNetworksResponse>

  Lists networks across regions for the specified parent.

  Parameters

  • request: ListAggregatedNetworksRequest
  • metadata: Metadata

  Returns Request<ListAggregatedNetworksRequest, ListNetworksResponse>

• listAggregated(
      request: ListAggregatedNetworksRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListAggregatedNetworksRequest, ListNetworksResponse>

  Lists networks across regions for the specified parent.

  Parameters

  • request: ListAggregatedNetworksRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListAggregatedNetworksRequest, ListNetworksResponse>

• listAggregated(
      request: ListAggregatedNetworksRequest,
  ): Request<ListAggregatedNetworksRequest, ListNetworksResponse>

  Lists networks across regions for the specified parent.

  Parameters

  • request: ListAggregatedNetworksRequest

  Returns Request<ListAggregatedNetworksRequest, ListNetworksResponse>

• listAggregated(
      request: ListAggregatedNetworksRequest,
      metadata: Metadata,
  ): Request<ListAggregatedNetworksRequest, ListNetworksResponse>

  Lists networks across regions for the specified parent.

  Parameters

  • request: ListAggregatedNetworksRequest
  • metadata: Metadata

  Returns Request<ListAggregatedNetworksRequest, ListNetworksResponse>

• listAggregated(
      request: ListAggregatedNetworksRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListAggregatedNetworksRequest, ListNetworksResponse>

  Lists networks across regions for the specified parent.

  Parameters

  • request: ListAggregatedNetworksRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListAggregatedNetworksRequest, ListNetworksResponse>

listOperations

• listOperations(
      request: ListOperationsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsRequest>

  Lists operations for this service address.

  Parameters

  • request: ListOperationsRequest
  • metadata: Metadata = ...
  • options: Partial<CallOptions> & RetryOptions = {}

  Returns Request<ListOperationsRequest>

update

• update(
      request: UpdateNetworkRequest,
  ): Request<UpdateNetworkRequest, Operation<GetOperationRequest>>

  Updates an existing network with new configuration parameters.

  Parameters

  • request: UpdateNetworkRequest

  Returns Request<UpdateNetworkRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateNetworkRequest,
      metadata: Metadata,
  ): Request<UpdateNetworkRequest, Operation<GetOperationRequest>>

  Updates an existing network with new configuration parameters.

  Parameters

  • request: UpdateNetworkRequest
  • metadata: Metadata

  Returns Request<UpdateNetworkRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateNetworkRequest, Operation<GetOperationRequest>>

  Updates an existing network with new configuration parameters.

  Parameters

  • request: UpdateNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateNetworkRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateNetworkRequest,
  ): Request<UpdateNetworkRequest, Operation<GetOperationRequest>>

  Updates an existing network with new configuration parameters.

  Parameters

  • request: UpdateNetworkRequest

  Returns Request<UpdateNetworkRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateNetworkRequest,
      metadata: Metadata,
  ): Request<UpdateNetworkRequest, Operation<GetOperationRequest>>

  Updates an existing network with new configuration parameters.

  Parameters

  • request: UpdateNetworkRequest
  • metadata: Metadata

  Returns Request<UpdateNetworkRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateNetworkRequest, Operation<GetOperationRequest>>

  Updates an existing network with new configuration parameters.

  Parameters

  • request: UpdateNetworkRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateNetworkRequest, Operation<GetOperationRequest>>