CloudNumberRegistry

import { CloudNumberRegistry } from "https://googleapis.deno.dev/v1/cloudnumberregistry:v1alpha.ts";

class CloudNumberRegistry {

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

async projectsLocationsCustomRangesCreate(

parent: string,

req: CustomRange,

opts?: ProjectsLocationsCustomRangesCreateOptions,

): Promise<Operation>;

async projectsLocationsCustomRangesDelete(name: string, opts?: ProjectsLocationsCustomRangesDeleteOptions): Promise<Operation>;

async projectsLocationsCustomRangesFindFreeIpRanges(name: string, opts?: ProjectsLocationsCustomRangesFindFreeIpRangesOptions): Promise<FindCustomRangeFreeIpRangesResponse>;

async projectsLocationsCustomRangesGet(name: string): Promise<CustomRange>;

async projectsLocationsCustomRangesList(parent: string, opts?: ProjectsLocationsCustomRangesListOptions): Promise<ListCustomRangesResponse>;

async projectsLocationsCustomRangesPatch(

req: CustomRange,

opts?: ProjectsLocationsCustomRangesPatchOptions,

): Promise<Operation>;

async projectsLocationsCustomRangesShowUtilization(name: string): Promise<ShowCustomRangeUtilizationResponse>;

async projectsLocationsDiscoveredRangesFindFreeIpRanges(name: string, opts?: ProjectsLocationsDiscoveredRangesFindFreeIpRangesOptions): Promise<FindDiscoveredRangeFreeIpRangesResponse>;

async projectsLocationsDiscoveredRangesGet(name: string): Promise<DiscoveredRange>;

async projectsLocationsDiscoveredRangesList(parent: string, opts?: ProjectsLocationsDiscoveredRangesListOptions): Promise<ListDiscoveredRangesResponse>;

async projectsLocationsDiscoveredRangesShowUtilization(name: string): Promise<ShowDiscoveredRangeUtilizationResponse>;

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsIpamAdminScopesCheckAvailability(parent: string, opts?: ProjectsLocationsIpamAdminScopesCheckAvailabilityOptions): Promise<CheckAvailabilityIpamAdminScopesResponse>;

async projectsLocationsIpamAdminScopesCleanup(name: string, req: CleanupIpamAdminScopeRequest): Promise<Operation>;

async projectsLocationsIpamAdminScopesCreate(

parent: string,

req: IpamAdminScope,

opts?: ProjectsLocationsIpamAdminScopesCreateOptions,

): Promise<Operation>;

async projectsLocationsIpamAdminScopesDelete(name: string, opts?: ProjectsLocationsIpamAdminScopesDeleteOptions): Promise<Operation>;

async projectsLocationsIpamAdminScopesDisable(name: string, req: DisableIpamAdminScopeRequest): Promise<Operation>;

async projectsLocationsIpamAdminScopesGet(name: string): Promise<IpamAdminScope>;

async projectsLocationsIpamAdminScopesList(parent: string, opts?: ProjectsLocationsIpamAdminScopesListOptions): Promise<ListIpamAdminScopesResponse>;

async projectsLocationsIpamAdminScopesPatch(

req: IpamAdminScope,

opts?: ProjectsLocationsIpamAdminScopesPatchOptions,

): Promise<Operation>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

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

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

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

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsRealmsCreate(

parent: string,

req: Realm,

opts?: ProjectsLocationsRealmsCreateOptions,

): Promise<Operation>;

async projectsLocationsRealmsDelete(name: string, opts?: ProjectsLocationsRealmsDeleteOptions): Promise<Operation>;

async projectsLocationsRealmsGet(name: string, opts?: ProjectsLocationsRealmsGetOptions): Promise<Realm>;

async projectsLocationsRealmsList(parent: string, opts?: ProjectsLocationsRealmsListOptions): Promise<ListRealmsResponse>;

async projectsLocationsRealmsPatch(

req: Realm,

opts?: ProjectsLocationsRealmsPatchOptions,

): Promise<Operation>;

async projectsLocationsRegistryBooksCreate(

parent: string,

req: RegistryBook,

opts?: ProjectsLocationsRegistryBooksCreateOptions,

): Promise<Operation>;

async projectsLocationsRegistryBooksDelete(name: string, opts?: ProjectsLocationsRegistryBooksDeleteOptions): Promise<Operation>;

async projectsLocationsRegistryBooksGet(name: string, opts?: ProjectsLocationsRegistryBooksGetOptions): Promise<RegistryBook>;

async projectsLocationsRegistryBooksList(parent: string, opts?: ProjectsLocationsRegistryBooksListOptions): Promise<ListRegistryBooksResponse>;

async projectsLocationsRegistryBooksPatch(

req: RegistryBook,

opts?: ProjectsLocationsRegistryBooksPatchOptions,

): Promise<Operation>;

async projectsLocationsRegistryBooksSearchIpResources(name: string, req: SearchIpResourcesRequest): Promise<SearchIpResourcesResponse>;

}

§Constructors

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

[src]

§Methods

projectsLocationsCustomRangesCreate(parent: string, req: CustomRange, opts?: ProjectsLocationsCustomRangesCreateOptions): Promise<Operation>

[src]

Creates a new CustomRange in a given project and location.

@param parent

Required. Value for parent.

projectsLocationsCustomRangesDelete(name: string, opts?: ProjectsLocationsCustomRangesDeleteOptions): Promise<Operation>

[src]

Deletes a single CustomRange.

@param name

Required. Name of the resource

projectsLocationsCustomRangesFindFreeIpRanges(name: string, opts?: ProjectsLocationsCustomRangesFindFreeIpRangesOptions): Promise<FindCustomRangeFreeIpRangesResponse>

[src]

Finds free IP ranges in a single CustomRange.

@param name

Required. Name of the CustomRange.

projectsLocationsCustomRangesGet(name: string): Promise<CustomRange>

[src]

Gets details of a single CustomRange.

@param name

Required. Name of the resource

projectsLocationsCustomRangesList(parent: string, opts?: ProjectsLocationsCustomRangesListOptions): Promise<ListCustomRangesResponse>

[src]

Lists CustomRanges in a given project and location.

@param parent

Required. Parent value for ListCustomRangesRequest

projectsLocationsCustomRangesPatch(name: string, req: CustomRange, opts?: ProjectsLocationsCustomRangesPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single CustomRange.

@param name

Required. Identifier. name of resource

projectsLocationsCustomRangesShowUtilization(name: string): Promise<ShowCustomRangeUtilizationResponse>

[src]

Gets the details of a single CustomRange and its utilization.

@param name

Required. Name of the resource

projectsLocationsDiscoveredRangesFindFreeIpRanges(name: string, opts?: ProjectsLocationsDiscoveredRangesFindFreeIpRangesOptions): Promise<FindDiscoveredRangeFreeIpRangesResponse>

[src]

Finds free IP ranges in a single DiscoveredRange.

@param name

Required. Name of the DiscoveredRange.

projectsLocationsDiscoveredRangesGet(name: string): Promise<DiscoveredRange>

[src]

Gets details of a single DiscoveredRange.

@param name

Required. Name of the resource

projectsLocationsDiscoveredRangesList(parent: string, opts?: ProjectsLocationsDiscoveredRangesListOptions): Promise<ListDiscoveredRangesResponse>

[src]

Lists DiscoveredRanges in a given project and location.

@param parent

Required. Parent value for ListDiscoveredRangesRequest

projectsLocationsDiscoveredRangesShowUtilization(name: string): Promise<ShowDiscoveredRangeUtilizationResponse>

[src]

Gets the details of a single DiscoveredRange and its utilization.

@param name

Required. Name of the resource

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsIpamAdminScopesCheckAvailability(parent: string, opts?: ProjectsLocationsIpamAdminScopesCheckAvailabilityOptions): Promise<CheckAvailabilityIpamAdminScopesResponse>

[src]

Checks the availability of IPAM admin scopes in a given project and location.

@param parent

Required. Parent value for the IpamAdminScopes.

projectsLocationsIpamAdminScopesCleanup(name: string, req: CleanupIpamAdminScopeRequest): Promise<Operation>

[src]

Cleans up a single IpamAdminScope.

@param name

Required. Name of the resource

projectsLocationsIpamAdminScopesCreate(parent: string, req: IpamAdminScope, opts?: ProjectsLocationsIpamAdminScopesCreateOptions): Promise<Operation>

[src]

Creates a new IpamAdminScope in a given project and location.

@param parent

Required. Value for parent.

projectsLocationsIpamAdminScopesDelete(name: string, opts?: ProjectsLocationsIpamAdminScopesDeleteOptions): Promise<Operation>

[src]

Deletes a single IpamAdminScope.

@param name

Required. Name of the resource

projectsLocationsIpamAdminScopesDisable(name: string, req: DisableIpamAdminScopeRequest): Promise<Operation>

[src]

Disables a single IpamAdminScope.

@param name

Required. Name of the resource

projectsLocationsIpamAdminScopesGet(name: string): Promise<IpamAdminScope>

[src]

Gets details of a single IpamAdminScope.

@param name

Required. Name of the resource

projectsLocationsIpamAdminScopesList(parent: string, opts?: ProjectsLocationsIpamAdminScopesListOptions): Promise<ListIpamAdminScopesResponse>

[src]

List all IPAM admin scopes in a given project and location.

@param parent

Required. Parent value for ListIpamAdminScopesRequest

projectsLocationsIpamAdminScopesPatch(name: string, req: IpamAdminScope, opts?: ProjectsLocationsIpamAdminScopesPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single IpamAdminScope.

@param name

Required. Identifier. name of resource

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(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.

projectsLocationsOperationsDelete(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.

projectsLocationsOperationsGet(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.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): 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.

projectsLocationsRealmsCreate(parent: string, req: Realm, opts?: ProjectsLocationsRealmsCreateOptions): Promise<Operation>

[src]

Creates a new Realm in a given project and location.

@param parent

Required. Value for parent.

projectsLocationsRealmsDelete(name: string, opts?: ProjectsLocationsRealmsDeleteOptions): Promise<Operation>

[src]

Deletes a single Realm.

@param name

Required. Name of the resource

projectsLocationsRealmsGet(name: string, opts?: ProjectsLocationsRealmsGetOptions): Promise<Realm>

[src]

Gets details of a single Realm.

@param name

Required. Name of the resource

projectsLocationsRealmsList(parent: string, opts?: ProjectsLocationsRealmsListOptions): Promise<ListRealmsResponse>

[src]

Lists Realms in a given project and location.

@param parent

Required. Parent value for ListRealmsRequest

projectsLocationsRealmsPatch(name: string, req: Realm, opts?: ProjectsLocationsRealmsPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single Realm.

@param name

Required. Identifier. Unique name/ID of the realm

projectsLocationsRegistryBooksCreate(parent: string, req: RegistryBook, opts?: ProjectsLocationsRegistryBooksCreateOptions): Promise<Operation>

[src]

Creates a new RegistryBook in a given project and location.

@param parent

Required. Value for parent.

projectsLocationsRegistryBooksDelete(name: string, opts?: ProjectsLocationsRegistryBooksDeleteOptions): Promise<Operation>

[src]

Deletes a single RegistryBook.

@param name

Required. Name of the resource

projectsLocationsRegistryBooksGet(name: string, opts?: ProjectsLocationsRegistryBooksGetOptions): Promise<RegistryBook>

[src]

Gets details of a single RegistryBook.

@param name

Required. Name of the resource

projectsLocationsRegistryBooksList(parent: string, opts?: ProjectsLocationsRegistryBooksListOptions): Promise<ListRegistryBooksResponse>

[src]

Lists RegistryBooks in a given project and location.

@param parent

Required. Parent value for ListRegistryBooksRequest

projectsLocationsRegistryBooksPatch(name: string, req: RegistryBook, opts?: ProjectsLocationsRegistryBooksPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single RegistryBook.

@param name

Required. Identifier. name of resource

projectsLocationsRegistryBooksSearchIpResources(name: string, req: SearchIpResourcesRequest): Promise<SearchIpResourcesResponse>

[src]

Searches IP resources in a given RegistryBook.

@param name

Required. The name of the RegistryBook to search in.