- 1.64.0 (latest)
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public class PublicAdvertisedPrefixesClient implements BackgroundResource
Service Description: The PublicAdvertisedPrefixes API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
String project = "project-309310695";
String publicAdvertisedPrefix = "publicAdvertisedPrefix1506440856";
PublicAdvertisedPrefix response =
publicAdvertisedPrefixesClient.get(project, publicAdvertisedPrefix);
}
Note: close() needs to be called on the PublicAdvertisedPrefixesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of PublicAdvertisedPrefixesSettings to create(). For example:
To customize credentials:
PublicAdvertisedPrefixesSettings publicAdvertisedPrefixesSettings =
PublicAdvertisedPrefixesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create(publicAdvertisedPrefixesSettings);
To customize the endpoint:
PublicAdvertisedPrefixesSettings publicAdvertisedPrefixesSettings =
PublicAdvertisedPrefixesSettings.newBuilder().setEndpoint(myEndpoint).build();
PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create(publicAdvertisedPrefixesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final PublicAdvertisedPrefixesClient create()
Constructs an instance of PublicAdvertisedPrefixesClient with default settings.
Type | Description |
PublicAdvertisedPrefixesClient |
Type | Description |
IOException |
create(PublicAdvertisedPrefixesSettings settings)
public static final PublicAdvertisedPrefixesClient create(PublicAdvertisedPrefixesSettings settings)
Constructs an instance of PublicAdvertisedPrefixesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | PublicAdvertisedPrefixesSettings |
Type | Description |
PublicAdvertisedPrefixesClient |
Type | Description |
IOException |
create(PublicAdvertisedPrefixesStub stub)
public static final PublicAdvertisedPrefixesClient create(PublicAdvertisedPrefixesStub stub)
Constructs an instance of PublicAdvertisedPrefixesClient, using the given stub for making calls. This is for advanced usage - prefer using create(PublicAdvertisedPrefixesSettings).
Name | Description |
stub | PublicAdvertisedPrefixesStub |
Type | Description |
PublicAdvertisedPrefixesClient |
Constructors
PublicAdvertisedPrefixesClient(PublicAdvertisedPrefixesSettings settings)
protected PublicAdvertisedPrefixesClient(PublicAdvertisedPrefixesSettings settings)
Constructs an instance of PublicAdvertisedPrefixesClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Name | Description |
settings | PublicAdvertisedPrefixesSettings |
PublicAdvertisedPrefixesClient(PublicAdvertisedPrefixesStub stub)
protected PublicAdvertisedPrefixesClient(PublicAdvertisedPrefixesStub stub)
Name | Description |
stub | PublicAdvertisedPrefixesStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
deleteAsync(DeletePublicAdvertisedPrefixeRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeletePublicAdvertisedPrefixeRequest request)
Deletes the specified PublicAdvertisedPrefix
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
DeletePublicAdvertisedPrefixeRequest request =
DeletePublicAdvertisedPrefixeRequest.newBuilder()
.setProject("project-309310695")
.setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
.setRequestId("requestId693933066")
.build();
Operation response = publicAdvertisedPrefixesClient.deleteAsync(request).get();
}
Name | Description |
request | DeletePublicAdvertisedPrefixeRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
deleteAsync(String project, String publicAdvertisedPrefix)
public final OperationFuture<Operation,Operation> deleteAsync(String project, String publicAdvertisedPrefix)
Deletes the specified PublicAdvertisedPrefix
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
String project = "project-309310695";
String publicAdvertisedPrefix = "publicAdvertisedPrefix1506440856";
Operation response =
publicAdvertisedPrefixesClient.deleteAsync(project, publicAdvertisedPrefix).get();
}
Name | Description |
project | String Project ID for this request. |
publicAdvertisedPrefix | String Name of the PublicAdvertisedPrefix resource to delete. |
Type | Description |
OperationFuture<Operation,Operation> |
deleteCallable()
public final UnaryCallable<DeletePublicAdvertisedPrefixeRequest,Operation> deleteCallable()
Deletes the specified PublicAdvertisedPrefix
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
DeletePublicAdvertisedPrefixeRequest request =
DeletePublicAdvertisedPrefixeRequest.newBuilder()
.setProject("project-309310695")
.setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
publicAdvertisedPrefixesClient.deleteCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<DeletePublicAdvertisedPrefixeRequest,Operation> |
deleteOperationCallable()
public final OperationCallable<DeletePublicAdvertisedPrefixeRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified PublicAdvertisedPrefix
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
DeletePublicAdvertisedPrefixeRequest request =
DeletePublicAdvertisedPrefixeRequest.newBuilder()
.setProject("project-309310695")
.setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
.setRequestId("requestId693933066")
.build();
OperationFuture
Type | Description |
OperationCallable<DeletePublicAdvertisedPrefixeRequest,Operation,Operation> |
get(GetPublicAdvertisedPrefixeRequest request)
public final PublicAdvertisedPrefix get(GetPublicAdvertisedPrefixeRequest request)
Returns the specified PublicAdvertisedPrefix resource.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
GetPublicAdvertisedPrefixeRequest request =
GetPublicAdvertisedPrefixeRequest.newBuilder()
.setProject("project-309310695")
.setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
.build();
PublicAdvertisedPrefix response = publicAdvertisedPrefixesClient.get(request);
}
Name | Description |
request | GetPublicAdvertisedPrefixeRequest The request object containing all of the parameters for the API call. |
Type | Description |
PublicAdvertisedPrefix |
get(String project, String publicAdvertisedPrefix)
public final PublicAdvertisedPrefix get(String project, String publicAdvertisedPrefix)
Returns the specified PublicAdvertisedPrefix resource.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
String project = "project-309310695";
String publicAdvertisedPrefix = "publicAdvertisedPrefix1506440856";
PublicAdvertisedPrefix response =
publicAdvertisedPrefixesClient.get(project, publicAdvertisedPrefix);
}
Name | Description |
project | String Project ID for this request. |
publicAdvertisedPrefix | String Name of the PublicAdvertisedPrefix resource to return. |
Type | Description |
PublicAdvertisedPrefix |
getCallable()
public final UnaryCallable<GetPublicAdvertisedPrefixeRequest,PublicAdvertisedPrefix> getCallable()
Returns the specified PublicAdvertisedPrefix resource.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
GetPublicAdvertisedPrefixeRequest request =
GetPublicAdvertisedPrefixeRequest.newBuilder()
.setProject("project-309310695")
.setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
.build();
ApiFuture
Type | Description |
UnaryCallable<GetPublicAdvertisedPrefixeRequest,PublicAdvertisedPrefix> |
getSettings()
public final PublicAdvertisedPrefixesSettings getSettings()
Type | Description |
PublicAdvertisedPrefixesSettings |
getStub()
public PublicAdvertisedPrefixesStub getStub()
Type | Description |
PublicAdvertisedPrefixesStub |
insertAsync(InsertPublicAdvertisedPrefixeRequest request)
public final OperationFuture<Operation,Operation> insertAsync(InsertPublicAdvertisedPrefixeRequest request)
Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
InsertPublicAdvertisedPrefixeRequest request =
InsertPublicAdvertisedPrefixeRequest.newBuilder()
.setProject("project-309310695")
.setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Operation response = publicAdvertisedPrefixesClient.insertAsync(request).get();
}
Name | Description |
request | InsertPublicAdvertisedPrefixeRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
insertAsync(String project, PublicAdvertisedPrefix publicAdvertisedPrefixResource)
public final OperationFuture<Operation,Operation> insertAsync(String project, PublicAdvertisedPrefix publicAdvertisedPrefixResource)
Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
String project = "project-309310695";
PublicAdvertisedPrefix publicAdvertisedPrefixResource =
PublicAdvertisedPrefix.newBuilder().build();
Operation response =
publicAdvertisedPrefixesClient.insertAsync(project, publicAdvertisedPrefixResource).get();
}
Name | Description |
project | String Project ID for this request. |
publicAdvertisedPrefixResource | PublicAdvertisedPrefix The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
insertCallable()
public final UnaryCallable<InsertPublicAdvertisedPrefixeRequest,Operation> insertCallable()
Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
InsertPublicAdvertisedPrefixeRequest request =
InsertPublicAdvertisedPrefixeRequest.newBuilder()
.setProject("project-309310695")
.setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
publicAdvertisedPrefixesClient.insertCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<InsertPublicAdvertisedPrefixeRequest,Operation> |
insertOperationCallable()
public final OperationCallable<InsertPublicAdvertisedPrefixeRequest,Operation,Operation> insertOperationCallable()
Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
InsertPublicAdvertisedPrefixeRequest request =
InsertPublicAdvertisedPrefixeRequest.newBuilder()
.setProject("project-309310695")
.setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture
Type | Description |
OperationCallable<InsertPublicAdvertisedPrefixeRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
list(ListPublicAdvertisedPrefixesRequest request)
public final PublicAdvertisedPrefixesClient.ListPagedResponse list(ListPublicAdvertisedPrefixesRequest request)
Lists the PublicAdvertisedPrefixes for a project.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
ListPublicAdvertisedPrefixesRequest request =
ListPublicAdvertisedPrefixesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
for (PublicAdvertisedPrefix element :
publicAdvertisedPrefixesClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListPublicAdvertisedPrefixesRequest The request object containing all of the parameters for the API call. |
Type | Description |
PublicAdvertisedPrefixesClient.ListPagedResponse |
list(String project)
public final PublicAdvertisedPrefixesClient.ListPagedResponse list(String project)
Lists the PublicAdvertisedPrefixes for a project.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
String project = "project-309310695";
for (PublicAdvertisedPrefix element :
publicAdvertisedPrefixesClient.list(project).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
project | String Project ID for this request. |
Type | Description |
PublicAdvertisedPrefixesClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListPublicAdvertisedPrefixesRequest,PublicAdvertisedPrefixList> listCallable()
Lists the PublicAdvertisedPrefixes for a project.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
ListPublicAdvertisedPrefixesRequest request =
ListPublicAdvertisedPrefixesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
while (true) {
PublicAdvertisedPrefixList response =
publicAdvertisedPrefixesClient.listCallable().call(request);
for (PublicAdvertisedPrefix element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListPublicAdvertisedPrefixesRequest,PublicAdvertisedPrefixList> |
listPagedCallable()
public final UnaryCallable<ListPublicAdvertisedPrefixesRequest,PublicAdvertisedPrefixesClient.ListPagedResponse> listPagedCallable()
Lists the PublicAdvertisedPrefixes for a project.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
ListPublicAdvertisedPrefixesRequest request =
ListPublicAdvertisedPrefixesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
ApiFuture
Type | Description |
UnaryCallable<ListPublicAdvertisedPrefixesRequest,ListPagedResponse> |
patchAsync(PatchPublicAdvertisedPrefixeRequest request)
public final OperationFuture<Operation,Operation> patchAsync(PatchPublicAdvertisedPrefixeRequest request)
Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
PatchPublicAdvertisedPrefixeRequest request =
PatchPublicAdvertisedPrefixeRequest.newBuilder()
.setProject("project-309310695")
.setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
.setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Operation response = publicAdvertisedPrefixesClient.patchAsync(request).get();
}
Name | Description |
request | PatchPublicAdvertisedPrefixeRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Operation,Operation> |
patchAsync(String project, String publicAdvertisedPrefix, PublicAdvertisedPrefix publicAdvertisedPrefixResource)
public final OperationFuture<Operation,Operation> patchAsync(String project, String publicAdvertisedPrefix, PublicAdvertisedPrefix publicAdvertisedPrefixResource)
Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
String project = "project-309310695";
String publicAdvertisedPrefix = "publicAdvertisedPrefix1506440856";
PublicAdvertisedPrefix publicAdvertisedPrefixResource =
PublicAdvertisedPrefix.newBuilder().build();
Operation response =
publicAdvertisedPrefixesClient
.patchAsync(project, publicAdvertisedPrefix, publicAdvertisedPrefixResource)
.get();
}
Name | Description |
project | String Project ID for this request. |
publicAdvertisedPrefix | String Name of the PublicAdvertisedPrefix resource to patch. |
publicAdvertisedPrefixResource | PublicAdvertisedPrefix The body resource for this request |
Type | Description |
OperationFuture<Operation,Operation> |
patchCallable()
public final UnaryCallable<PatchPublicAdvertisedPrefixeRequest,Operation> patchCallable()
Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
PatchPublicAdvertisedPrefixeRequest request =
PatchPublicAdvertisedPrefixeRequest.newBuilder()
.setProject("project-309310695")
.setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
.setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
publicAdvertisedPrefixesClient.patchCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<PatchPublicAdvertisedPrefixeRequest,Operation> |
patchOperationCallable()
public final OperationCallable<PatchPublicAdvertisedPrefixeRequest,Operation,Operation> patchOperationCallable()
Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
Sample code:
try (PublicAdvertisedPrefixesClient publicAdvertisedPrefixesClient =
PublicAdvertisedPrefixesClient.create()) {
PatchPublicAdvertisedPrefixeRequest request =
PatchPublicAdvertisedPrefixeRequest.newBuilder()
.setProject("project-309310695")
.setPublicAdvertisedPrefix("publicAdvertisedPrefix1506440856")
.setPublicAdvertisedPrefixResource(PublicAdvertisedPrefix.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture
Type | Description |
OperationCallable<PatchPublicAdvertisedPrefixeRequest,Operation,Operation> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()