Class SubnetService

constructor

• new SubnetService(sdk: SDKInterface): SubnetService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns SubnetService

$type

create

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

  Creates a new subnet with the specified configuration.

  Parameters

  • request: CreateSubnetRequest

  Returns Request<CreateSubnetRequest, Operation<GetOperationRequest>>

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

  Creates a new subnet with the specified configuration.

  Parameters

  • request: CreateSubnetRequest
  • metadata: Metadata

  Returns Request<CreateSubnetRequest, Operation<GetOperationRequest>>

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

  Creates a new subnet with the specified configuration.

  Parameters

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

  Returns Request<CreateSubnetRequest, Operation<GetOperationRequest>>

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

  Creates a new subnet with the specified configuration.

  Parameters

  • request: CreateSubnetRequest

  Returns Request<CreateSubnetRequest, Operation<GetOperationRequest>>

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

  Creates a new subnet with the specified configuration.

  Parameters

  • request: CreateSubnetRequest
  • metadata: Metadata

  Returns Request<CreateSubnetRequest, Operation<GetOperationRequest>>

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

  Creates a new subnet with the specified configuration.

  Parameters

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

  Returns Request<CreateSubnetRequest, Operation<GetOperationRequest>>

delete

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

  Deletes a subnet by its ID.

  Parameters

  • request: DeleteSubnetRequest

  Returns Request<DeleteSubnetRequest, Operation<GetOperationRequest>>

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

  Deletes a subnet by its ID.

  Parameters

  • request: DeleteSubnetRequest
  • metadata: Metadata

  Returns Request<DeleteSubnetRequest, Operation<GetOperationRequest>>

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

  Deletes a subnet by its ID.

  Parameters

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

  Returns Request<DeleteSubnetRequest, Operation<GetOperationRequest>>

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

  Deletes a subnet by its ID.

  Parameters

  • request: DeleteSubnetRequest

  Returns Request<DeleteSubnetRequest, Operation<GetOperationRequest>>

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

  Deletes a subnet by its ID.

  Parameters

  • request: DeleteSubnetRequest
  • metadata: Metadata

  Returns Request<DeleteSubnetRequest, Operation<GetOperationRequest>>

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

  Deletes a subnet by its ID.

  Parameters

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

  Returns Request<DeleteSubnetRequest, Operation<GetOperationRequest>>

filter

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

  Calls the filter method.

  Parameters

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

  Returns AsyncGenerator<Subnet>

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

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

  Parameters

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

  Returns AsyncGenerator<Subnet>

get

• get(request: GetSubnetRequest): Request<GetSubnetRequest, Subnet>

  Retrieves a subnet by its ID.

  Parameters

  • request: GetSubnetRequest

  Returns Request<GetSubnetRequest, Subnet>

• get(
      request: GetSubnetRequest,
      metadata: Metadata,
  ): Request<GetSubnetRequest, Subnet>

  Retrieves a subnet by its ID.

  Parameters

  • request: GetSubnetRequest
  • metadata: Metadata

  Returns Request<GetSubnetRequest, Subnet>

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

  Retrieves a subnet by its ID.

  Parameters

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

  Returns Request<GetSubnetRequest, Subnet>

• get(request: GetSubnetRequest): Request<GetSubnetRequest, Subnet>

  Retrieves a subnet by its ID.

  Parameters

  • request: GetSubnetRequest

  Returns Request<GetSubnetRequest, Subnet>

• get(
      request: GetSubnetRequest,
      metadata: Metadata,
  ): Request<GetSubnetRequest, Subnet>

  Retrieves a subnet by its ID.

  Parameters

  • request: GetSubnetRequest
  • metadata: Metadata

  Returns Request<GetSubnetRequest, Subnet>

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

  Retrieves a subnet by its ID.

  Parameters

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

  Returns Request<GetSubnetRequest, Subnet>

getByName

• getByName(
      request: GetSubnetByNameRequest,
  ): Request<GetSubnetByNameRequest, Subnet>

  Retrieves a subnet by its name within a specified parent.

  Parameters

  • request: GetSubnetByNameRequest

  Returns Request<GetSubnetByNameRequest, Subnet>

• getByName(
      request: GetSubnetByNameRequest,
      metadata: Metadata,
  ): Request<GetSubnetByNameRequest, Subnet>

  Retrieves a subnet by its name within a specified parent.

  Parameters

  • request: GetSubnetByNameRequest
  • metadata: Metadata

  Returns Request<GetSubnetByNameRequest, Subnet>

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

  Retrieves a subnet by its name within a specified parent.

  Parameters

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

  Returns Request<GetSubnetByNameRequest, Subnet>

• getByName(
      request: GetSubnetByNameRequest,
  ): Request<GetSubnetByNameRequest, Subnet>

  Retrieves a subnet by its name within a specified parent.

  Parameters

  • request: GetSubnetByNameRequest

  Returns Request<GetSubnetByNameRequest, Subnet>

• getByName(
      request: GetSubnetByNameRequest,
      metadata: Metadata,
  ): Request<GetSubnetByNameRequest, Subnet>

  Retrieves a subnet by its name within a specified parent.

  Parameters

  • request: GetSubnetByNameRequest
  • metadata: Metadata

  Returns Request<GetSubnetByNameRequest, Subnet>

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

  Retrieves a subnet by its name within a specified parent.

  Parameters

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

  Returns Request<GetSubnetByNameRequest, Subnet>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListSubnetsRequest,
  ): Request<ListSubnetsRequest, ListSubnetsResponse>

  Lists subnets within a specified parent.

  Parameters

  • request: ListSubnetsRequest

  Returns Request<ListSubnetsRequest, ListSubnetsResponse>

• list(
      request: ListSubnetsRequest,
      metadata: Metadata,
  ): Request<ListSubnetsRequest, ListSubnetsResponse>

  Lists subnets within a specified parent.

  Parameters

  • request: ListSubnetsRequest
  • metadata: Metadata

  Returns Request<ListSubnetsRequest, ListSubnetsResponse>

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

  Lists subnets within a specified parent.

  Parameters

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

  Returns Request<ListSubnetsRequest, ListSubnetsResponse>

• list(
      request: ListSubnetsRequest,
  ): Request<ListSubnetsRequest, ListSubnetsResponse>

  Lists subnets within a specified parent.

  Parameters

  • request: ListSubnetsRequest

  Returns Request<ListSubnetsRequest, ListSubnetsResponse>

• list(
      request: ListSubnetsRequest,
      metadata: Metadata,
  ): Request<ListSubnetsRequest, ListSubnetsResponse>

  Lists subnets within a specified parent.

  Parameters

  • request: ListSubnetsRequest
  • metadata: Metadata

  Returns Request<ListSubnetsRequest, ListSubnetsResponse>

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

  Lists subnets within a specified parent.

  Parameters

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

  Returns Request<ListSubnetsRequest, ListSubnetsResponse>

listAggregated

• listAggregated(
      request: ListAggregatedSubnetsRequest,
  ): Request<ListAggregatedSubnetsRequest, ListSubnetsResponse>

  Lists subnets across regions for the specified parent.

  Parameters

  • request: ListAggregatedSubnetsRequest

  Returns Request<ListAggregatedSubnetsRequest, ListSubnetsResponse>

• listAggregated(
      request: ListAggregatedSubnetsRequest,
      metadata: Metadata,
  ): Request<ListAggregatedSubnetsRequest, ListSubnetsResponse>

  Lists subnets across regions for the specified parent.

  Parameters

  • request: ListAggregatedSubnetsRequest
  • metadata: Metadata

  Returns Request<ListAggregatedSubnetsRequest, ListSubnetsResponse>

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

  Lists subnets across regions for the specified parent.

  Parameters

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

  Returns Request<ListAggregatedSubnetsRequest, ListSubnetsResponse>

• listAggregated(
      request: ListAggregatedSubnetsRequest,
  ): Request<ListAggregatedSubnetsRequest, ListSubnetsResponse>

  Lists subnets across regions for the specified parent.

  Parameters

  • request: ListAggregatedSubnetsRequest

  Returns Request<ListAggregatedSubnetsRequest, ListSubnetsResponse>

• listAggregated(
      request: ListAggregatedSubnetsRequest,
      metadata: Metadata,
  ): Request<ListAggregatedSubnetsRequest, ListSubnetsResponse>

  Lists subnets across regions for the specified parent.

  Parameters

  • request: ListAggregatedSubnetsRequest
  • metadata: Metadata

  Returns Request<ListAggregatedSubnetsRequest, ListSubnetsResponse>

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

  Lists subnets across regions for the specified parent.

  Parameters

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

  Returns Request<ListAggregatedSubnetsRequest, ListSubnetsResponse>

listByNetwork

• listByNetwork(
      request: ListSubnetsByNetworkRequest,
  ): Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

  Lists subnets that belong to a specified network.

  Parameters

  • request: ListSubnetsByNetworkRequest

  Returns Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

• listByNetwork(
      request: ListSubnetsByNetworkRequest,
      metadata: Metadata,
  ): Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

  Lists subnets that belong to a specified network.

  Parameters

  • request: ListSubnetsByNetworkRequest
  • metadata: Metadata

  Returns Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

• listByNetwork(
      request: ListSubnetsByNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

  Lists subnets that belong to a specified network.

  Parameters

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

  Returns Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

• listByNetwork(
      request: ListSubnetsByNetworkRequest,
  ): Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

  Lists subnets that belong to a specified network.

  Parameters

  • request: ListSubnetsByNetworkRequest

  Returns Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

• listByNetwork(
      request: ListSubnetsByNetworkRequest,
      metadata: Metadata,
  ): Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

  Lists subnets that belong to a specified network.

  Parameters

  • request: ListSubnetsByNetworkRequest
  • metadata: Metadata

  Returns Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

• listByNetwork(
      request: ListSubnetsByNetworkRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

  Lists subnets that belong to a specified network.

  Parameters

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

  Returns Request<ListSubnetsByNetworkRequest, ListSubnetsResponse>

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: UpdateSubnetRequest,
  ): Request<UpdateSubnetRequest, Operation<GetOperationRequest>>

  Updates an existing subnet with new configuration parameters.

  Parameters

  • request: UpdateSubnetRequest

  Returns Request<UpdateSubnetRequest, Operation<GetOperationRequest>>

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

  Updates an existing subnet with new configuration parameters.

  Parameters

  • request: UpdateSubnetRequest
  • metadata: Metadata

  Returns Request<UpdateSubnetRequest, Operation<GetOperationRequest>>

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

  Updates an existing subnet with new configuration parameters.

  Parameters

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

  Returns Request<UpdateSubnetRequest, Operation<GetOperationRequest>>

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

  Updates an existing subnet with new configuration parameters.

  Parameters

  • request: UpdateSubnetRequest

  Returns Request<UpdateSubnetRequest, Operation<GetOperationRequest>>

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

  Updates an existing subnet with new configuration parameters.

  Parameters

  • request: UpdateSubnetRequest
  • metadata: Metadata

  Returns Request<UpdateSubnetRequest, Operation<GetOperationRequest>>

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

  Updates an existing subnet with new configuration parameters.

  Parameters

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

  Returns Request<UpdateSubnetRequest, Operation<GetOperationRequest>>