diff --git a/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java b/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java index e31f04c827..47d819378f 100644 --- a/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java +++ b/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java @@ -31,6 +31,7 @@ import java.util.List; import java.util.Map; import java.util.Optional; +import java.util.stream.Collectors; public class ServiceClientCommentComposer { // Tokens. @@ -231,15 +232,17 @@ private static String createTableOfMethods(List methodAndVari StringBuilder tableBuilder = new StringBuilder(); tableBuilder .append("\n") + .append(" \n") .append(" \n") .append(" \n") .append(" \n") - .append(" \n"); + .append(" \n") + .append(" \n"); for (MethodAndVariants method : methodAndVariantsList) { tableBuilder .append(" \n") .append(" \n") .append(" \n").append(" \n"); } - tableBuilder.append(" \n").append("
Methods
MethodDescriptionMethod VariantsMethod Variants
") - .append(method.method) + .append(CommentFormatter.formatAsJavaDocComment(method.method, null)) .append("") .append(CommentFormatter.formatAsJavaDocComment(method.description, null)) @@ -253,18 +256,25 @@ private static String createTableOfMethods(List methodAndVari generateUnorderedListMethodVariants(tableBuilder, CALLABLE_METHODS, method.callableVariants); tableBuilder.append("
\n"); + tableBuilder.append(" \n"); return tableBuilder.toString(); } private static void generateUnorderedListMethodVariants( StringBuilder tableBuilder, String methodType, List methodVariants) { + List formattedMethodVariants = + methodVariants.stream() + .map( + methodVariant -> + CommentFormatter.formatAsJavaDocComment( + methodVariant, null)) // Apply the formatting to each element + .collect(Collectors.toList()); if (!methodVariants.isEmpty()) { tableBuilder .append(" " + methodType + " ") .append("
    \n") .append("
  • ") - .append(String.join("\n
  • ", methodVariants)) + .append(String.join("\n
  • ", formattedMethodVariants)) .append("\n") .append("
") .append("\n"); diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/engine/writer/goldens/GrpcServiceClientWithNestedClassImport.golden b/gapic-generator-java/src/test/java/com/google/api/generator/engine/writer/goldens/GrpcServiceClientWithNestedClassImport.golden index 2fad27b9be..9a8f46553d 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/engine/writer/goldens/GrpcServiceClientWithNestedClassImport.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/engine/writer/goldens/GrpcServiceClientWithNestedClassImport.golden @@ -32,25 +32,26 @@ import javax.annotation.Generated; * calls close(). * * + * * * * * + * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
NestedMessageMethod

NestedMessageMethod

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • nestedMessageMethod(Outer.Middle request) + *

  • nestedMessageMethod(Outer.Middle request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • nestedMessageMethodCallable() + *

  • nestedMessageMethodCallable() *

*
* *

See the individual methods for example code. diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/BookshopClient.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/BookshopClient.golden index 4f8565e16b..13e5485039 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/BookshopClient.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/BookshopClient.golden @@ -32,30 +32,31 @@ import javax.annotation.Generated; * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
GetBook

GetBook

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getBook(GetBookRequest request) + *

  • getBook(GetBookRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getBook(int booksCount, List books) - *
  • getBook(String booksList, List books) + *

  • getBook(int booksCount, List<Book> books) + *

  • getBook(String booksList, List<Book> books) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getBookCallable() + *

  • getBookCallable() *

*
* *

See the individual methods for example code. diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceClient.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceClient.golden index 4b7afa4cf4..aec12869e4 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceClient.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceClient.golden @@ -31,39 +31,40 @@ import javax.annotation.Generated; * close(). * * + * * * * * + * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
FastFibonacci

FastFibonacci

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • fastFibonacci(FibonacciRequest request) + *

  • fastFibonacci(FibonacciRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • fastFibonacciCallable() + *

  • fastFibonacciCallable() *

*
SlowFibonacci

SlowFibonacci

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • slowFibonacci(FibonacciRequest request) + *

  • slowFibonacci(FibonacciRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • slowFibonacciCallable() + *

  • slowFibonacciCallable() *

*
* *

See the individual methods for example code. diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/EchoClient.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/EchoClient.golden index 8e92d7365d..f67a50d9c0 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/EchoClient.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/EchoClient.golden @@ -53,158 +53,159 @@ import javax.annotation.Generated; * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
Echo

Echo

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • echo(EchoRequest request) + *

  • echo(EchoRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • echo() - *
  • echo(ResourceName parent) - *
  • echo(Status error) - *
  • echo(FoobarName name) - *
  • echo(String content) - *
  • echo(String name) - *
  • echo(String parent) - *
  • echo(String content, Severity severity) + *

  • echo() + *

  • echo(ResourceName parent) + *

  • echo(Status error) + *

  • echo(FoobarName name) + *

  • echo(String content) + *

  • echo(String name) + *

  • echo(String parent) + *

  • echo(String content, Severity severity) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • echoCallable() + *

  • echoCallable() *

*
Expand

Expand

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • expandCallable() + *

  • expandCallable() *

*
Collect

Collect

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • collectCallable() + *

  • collectCallable() *

*
Chat

Chat

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • chatCallable() + *

  • chatCallable() *

*
ChatAgain

ChatAgain

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • chatAgainCallable() + *

  • chatAgainCallable() *

*
PagedExpand

PagedExpand

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • pagedExpand(PagedExpandRequest request) + *

  • pagedExpand(PagedExpandRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • pagedExpandPagedCallable() - *
  • pagedExpandCallable() + *

  • pagedExpandPagedCallable() + *

  • pagedExpandCallable() *

*
SimplePagedExpand

SimplePagedExpand

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • simplePagedExpand(PagedExpandRequest request) + *

  • simplePagedExpand(PagedExpandRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • simplePagedExpand() + *

  • simplePagedExpand() *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • simplePagedExpandPagedCallable() - *
  • simplePagedExpandCallable() + *

  • simplePagedExpandPagedCallable() + *

  • simplePagedExpandCallable() *

*
Wait

Wait

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • waitAsync(WaitRequest request) + *

  • waitAsync(WaitRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • waitAsync(Duration ttl) - *
  • waitAsync(Timestamp endTime) + *

  • waitAsync(Duration ttl) + *

  • waitAsync(Timestamp endTime) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • waitOperationCallable() - *
  • waitCallable() + *

  • waitOperationCallable() + *

  • waitCallable() *

*
Block

Block

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • block(BlockRequest request) + *

  • block(BlockRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • blockCallable() + *

  • blockCallable() *

*
CollideName

CollideName

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • collideName(EchoRequest request) + *

  • collideName(EchoRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • collideNameCallable() + *

  • collideNameCallable() *

*
* *

See the individual methods for example code. diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/IdentityClient.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/IdentityClient.golden index e87d39b482..efb41dc308 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/IdentityClient.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/IdentityClient.golden @@ -41,98 +41,99 @@ import javax.annotation.Generated; * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
CreateUser

CreateUser

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createUser(CreateUserRequest request) + *

  • createUser(CreateUserRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createUser(String parent, String displayName, String email) - *
  • createUser(String parent, String displayName, String email, int age, String nickname, boolean enableNotifications, double heightFeet) - *
  • createUser(String parent, String displayName, String email, String hobbyName, String songName, int weeklyFrequency, String companyName, String title, String subject, String artistName) + *

  • createUser(String parent, String displayName, String email) + *

  • createUser(String parent, String displayName, String email, int age, String nickname, boolean enableNotifications, double heightFeet) + *

  • createUser(String parent, String displayName, String email, String hobbyName, String songName, int weeklyFrequency, String companyName, String title, String subject, String artistName) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createUserCallable() + *

  • createUserCallable() *

*
GetUser

GetUser

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getUser(GetUserRequest request) + *

  • getUser(GetUserRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getUser(UserName name) - *
  • getUser(String name) + *

  • getUser(UserName name) + *

  • getUser(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getUserCallable() + *

  • getUserCallable() *

*
UpdateUser

UpdateUser

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateUser(UpdateUserRequest request) + *

  • updateUser(UpdateUserRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateUserCallable() + *

  • updateUserCallable() *

*
DeleteUser

DeleteUser

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteUser(DeleteUserRequest request) + *

  • deleteUser(DeleteUserRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteUser(UserName name) - *
  • deleteUser(String name) + *

  • deleteUser(UserName name) + *

  • deleteUser(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteUserCallable() + *

  • deleteUserCallable() *

*
ListUsers

ListUsers

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listUsers(ListUsersRequest request) + *

  • listUsers(ListUsersRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listUsersPagedCallable() - *
  • listUsersCallable() + *

  • listUsersPagedCallable() + *

  • listUsersCallable() *

*
* *

See the individual methods for example code. diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/MessagingClient.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/MessagingClient.golden index 6f6475005b..359ba58624 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/MessagingClient.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/MessagingClient.golden @@ -48,241 +48,242 @@ import javax.annotation.Generated; * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
CreateRoom

CreateRoom

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createRoom(CreateRoomRequest request) + *

  • createRoom(CreateRoomRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createRoom(String displayName, String description) + *

  • createRoom(String displayName, String description) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createRoomCallable() + *

  • createRoomCallable() *

*
GetRoom

GetRoom

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getRoom(GetRoomRequest request) + *

  • getRoom(GetRoomRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getRoom(RoomName name) - *
  • getRoom(String name) + *

  • getRoom(RoomName name) + *

  • getRoom(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getRoomCallable() + *

  • getRoomCallable() *

*
UpdateRoom

UpdateRoom

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateRoom(UpdateRoomRequest request) + *

  • updateRoom(UpdateRoomRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateRoomCallable() + *

  • updateRoomCallable() *

*
DeleteRoom

DeleteRoom

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteRoom(DeleteRoomRequest request) + *

  • deleteRoom(DeleteRoomRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteRoom(RoomName name) - *
  • deleteRoom(String name) + *

  • deleteRoom(RoomName name) + *

  • deleteRoom(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteRoomCallable() + *

  • deleteRoomCallable() *

*
ListRooms

ListRooms

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listRooms(ListRoomsRequest request) + *

  • listRooms(ListRoomsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listRoomsPagedCallable() - *
  • listRoomsCallable() + *

  • listRoomsPagedCallable() + *

  • listRoomsCallable() *

*
CreateBlurb

CreateBlurb

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createBlurb(CreateBlurbRequest request) + *

  • createBlurb(CreateBlurbRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createBlurb(ProfileName parent, ByteString image) - *
  • createBlurb(ProfileName parent, String text) - *
  • createBlurb(RoomName parent, ByteString image) - *
  • createBlurb(RoomName parent, String text) - *
  • createBlurb(String parent, ByteString image) - *
  • createBlurb(String parent, String text) + *

  • createBlurb(ProfileName parent, ByteString image) + *

  • createBlurb(ProfileName parent, String text) + *

  • createBlurb(RoomName parent, ByteString image) + *

  • createBlurb(RoomName parent, String text) + *

  • createBlurb(String parent, ByteString image) + *

  • createBlurb(String parent, String text) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createBlurbCallable() + *

  • createBlurbCallable() *

*
GetBlurb

GetBlurb

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getBlurb(GetBlurbRequest request) + *

  • getBlurb(GetBlurbRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getBlurb(BlurbName name) - *
  • getBlurb(String name) + *

  • getBlurb(BlurbName name) + *

  • getBlurb(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getBlurbCallable() + *

  • getBlurbCallable() *

*
UpdateBlurb

UpdateBlurb

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateBlurb(UpdateBlurbRequest request) + *

  • updateBlurb(UpdateBlurbRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateBlurbCallable() + *

  • updateBlurbCallable() *

*
DeleteBlurb

DeleteBlurb

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteBlurb(DeleteBlurbRequest request) + *

  • deleteBlurb(DeleteBlurbRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteBlurb(BlurbName name) - *
  • deleteBlurb(String name) + *

  • deleteBlurb(BlurbName name) + *

  • deleteBlurb(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteBlurbCallable() + *

  • deleteBlurbCallable() *

*
ListBlurbs

ListBlurbs

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listBlurbs(ListBlurbsRequest request) + *

  • listBlurbs(ListBlurbsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listBlurbs(ProfileName parent) - *
  • listBlurbs(RoomName parent) - *
  • listBlurbs(String parent) + *

  • listBlurbs(ProfileName parent) + *

  • listBlurbs(RoomName parent) + *

  • listBlurbs(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listBlurbsPagedCallable() - *
  • listBlurbsCallable() + *

  • listBlurbsPagedCallable() + *

  • listBlurbsCallable() *

*
SearchBlurbs

SearchBlurbs

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • searchBlurbsAsync(SearchBlurbsRequest request) + *

  • searchBlurbsAsync(SearchBlurbsRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • searchBlurbsAsync(String query) + *

  • searchBlurbsAsync(String query) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • searchBlurbsOperationCallable() - *
  • searchBlurbsCallable() + *

  • searchBlurbsOperationCallable() + *

  • searchBlurbsCallable() *

*
StreamBlurbs

StreamBlurbs

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • streamBlurbsCallable() + *

  • streamBlurbsCallable() *

*
SendBlurbs

SendBlurbs

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • sendBlurbsCallable() + *

  • sendBlurbsCallable() *

*
Connect

Connect

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • connectCallable() + *

  • connectCallable() *

*
* *

See the individual methods for example code. diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoClient.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoClient.golden index 9d8e3fa400..bf68adf425 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoClient.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoClient.golden @@ -48,184 +48,185 @@ import javax.annotation.Generated; * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
Echo

Echo

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • echo(EchoRequest request) + *

  • echo(EchoRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • echo() - *
  • echo(ResourceName parent) - *
  • echo(Status error) - *
  • echo(FoobarName name) - *
  • echo(String content) - *
  • echo(String name) - *
  • echo(String parent) - *
  • echo(String content, Severity severity) + *

  • echo() + *

  • echo(ResourceName parent) + *

  • echo(Status error) + *

  • echo(FoobarName name) + *

  • echo(String content) + *

  • echo(String name) + *

  • echo(String parent) + *

  • echo(String content, Severity severity) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • echoCallable() + *

  • echoCallable() *

*
Expand

Expand

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • expandCallable() + *

  • expandCallable() *

*
PagedExpand

PagedExpand

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • pagedExpand(PagedExpandRequest request) + *

  • pagedExpand(PagedExpandRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • pagedExpandPagedCallable() - *
  • pagedExpandCallable() + *

  • pagedExpandPagedCallable() + *

  • pagedExpandCallable() *

*
SimplePagedExpand

SimplePagedExpand

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • simplePagedExpand(PagedExpandRequest request) + *

  • simplePagedExpand(PagedExpandRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • simplePagedExpand() + *

  • simplePagedExpand() *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • simplePagedExpandPagedCallable() - *
  • simplePagedExpandCallable() + *

  • simplePagedExpandPagedCallable() + *

  • simplePagedExpandCallable() *

*
Wait

Wait

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • waitAsync(WaitRequest request) + *

  • waitAsync(WaitRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • waitAsync(Duration ttl) - *
  • waitAsync(Timestamp endTime) + *

  • waitAsync(Duration ttl) + *

  • waitAsync(Timestamp endTime) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • waitOperationCallable() - *
  • waitCallable() + *

  • waitOperationCallable() + *

  • waitCallable() *

*
Block

Block

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • block(BlockRequest request) + *

  • block(BlockRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • blockCallable() + *

  • blockCallable() *

*
CollideName

CollideName

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • collideName(EchoRequest request) + *

  • collideName(EchoRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • collideNameCallable() + *

  • collideNameCallable() *

*
NestedBinding

NestedBinding

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • nestedBinding(EchoRequest request) + *

  • nestedBinding(EchoRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • nestedBindingCallable() + *

  • nestedBindingCallable() *

*
Chat

Chat

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • chatCallable() + *

  • chatCallable() *

*
NoBinding

NoBinding

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • noBinding(EchoRequest request) + *

  • noBinding(EchoRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • noBindingCallable() + *

  • noBindingCallable() *

*
UpdateCase

UpdateCase

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateCase(UpdateCaseRequest request) + *

  • updateCase(UpdateCaseRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateCase(Case case_, FieldMask updateMask) + *

  • updateCase(Case case_, FieldMask updateMask) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateCaseCallable() + *

  • updateCaseCallable() *

*
* *

See the individual methods for example code. diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoEmpty.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoEmpty.golden index 5076d1bee1..b423bbbb94 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoEmpty.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoEmpty.golden @@ -26,6 +26,7 @@ import javax.annotation.Generated; * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedClient.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedClient.golden index 7569bf2472..138bee4bc1 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedClient.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedClient.golden @@ -33,45 +33,46 @@ import javax.annotation.Generated; * threads. In the example above, try-with-resources is used, which automatically calls close(). * *
Methods
MethodDescription
+ * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
CraftEvilPlan

CraftEvilPlan

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • craftEvilPlan(EvilRequest request) + *

  • craftEvilPlan(EvilRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • craftEvilPlanCallable() + *

  • craftEvilPlanCallable() *

*
BrainstormEvilPlans

BrainstormEvilPlans

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • brainstormEvilPlansCallable() + *

  • brainstormEvilPlansCallable() *

*
PersuadeEvilPlan

PersuadeEvilPlan

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • persuadeEvilPlanCallable() + *

  • persuadeEvilPlanCallable() *

*
* *

See the individual methods for example code. diff --git a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/ComplianceClient.java b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/ComplianceClient.java index d4b517ce0a..93839af2ef 100644 --- a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/ComplianceClient.java +++ b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/ComplianceClient.java @@ -80,226 +80,227 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
RepeatDataBody

RepeatDataBody

This method echoes the ComplianceData request. This method exercises sending the entire request object in the REST body.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • repeatDataBody(RepeatRequest request) + *

  • repeatDataBody(RepeatRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • repeatDataBodyCallable() + *

  • repeatDataBodyCallable() *

*
RepeatDataBodyInfo

RepeatDataBodyInfo

This method echoes the ComplianceData request. This method exercises sending the a message-type field in the REST body. Per AIP-127, only top-level, non-repeated fields can be sent this way.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • repeatDataBodyInfo(RepeatRequest request) + *

  • repeatDataBodyInfo(RepeatRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • repeatDataBodyInfoCallable() + *

  • repeatDataBodyInfoCallable() *

*
RepeatDataQuery

RepeatDataQuery

This method echoes the ComplianceData request. This method exercises sending all request fields as query parameters.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • repeatDataQuery(RepeatRequest request) + *

  • repeatDataQuery(RepeatRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • repeatDataQueryCallable() + *

  • repeatDataQueryCallable() *

*
RepeatDataSimplePath

RepeatDataSimplePath

This method echoes the ComplianceData request. This method exercises sending some parameters as "simple" path variables (i.e., of the form "/bar/{foo}" rather than "/{foo=bar/*}"), and the rest as query parameters.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • repeatDataSimplePath(RepeatRequest request) + *

  • repeatDataSimplePath(RepeatRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • repeatDataSimplePathCallable() + *

  • repeatDataSimplePathCallable() *

*
RepeatDataPathResource

RepeatDataPathResource

Same as RepeatDataSimplePath, but with a path resource.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • repeatDataPathResource(RepeatRequest request) + *

  • repeatDataPathResource(RepeatRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • repeatDataPathResourceCallable() + *

  • repeatDataPathResourceCallable() *

*
RepeatDataPathTrailingResource

RepeatDataPathTrailingResource

Same as RepeatDataSimplePath, but with a trailing resource.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • repeatDataPathTrailingResource(RepeatRequest request) + *

  • repeatDataPathTrailingResource(RepeatRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • repeatDataPathTrailingResourceCallable() + *

  • repeatDataPathTrailingResourceCallable() *

*
RepeatDataBodyPut

RepeatDataBodyPut

This method echoes the ComplianceData request, using the HTTP PUT method.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • repeatDataBodyPut(RepeatRequest request) + *

  • repeatDataBodyPut(RepeatRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • repeatDataBodyPutCallable() + *

  • repeatDataBodyPutCallable() *

*
RepeatDataBodyPatch

RepeatDataBodyPatch

This method echoes the ComplianceData request, using the HTTP PATCH method.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • repeatDataBodyPatch(RepeatRequest request) + *

  • repeatDataBodyPatch(RepeatRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • repeatDataBodyPatchCallable() + *

  • repeatDataBodyPatchCallable() *

*
GetEnum

GetEnum

This method requests an enum value from the server. Depending on the contents of EnumRequest, the enum value returned will be a known enum declared in the .proto file, or a made-up enum value the is unknown to the client. To verify that clients can round-trip unknown enum vaues they receive, use the response from this RPC as the request to VerifyEnum() *

The values of enums sent by the server when a known or unknown value is requested will be the same within a single Showcase server run (this is needed for VerifyEnum() to work) but are not guaranteed to be the same across separate Showcase server runs.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getEnum(EnumRequest request) + *

  • getEnum(EnumRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getEnumCallable() + *

  • getEnumCallable() *

*
VerifyEnum

VerifyEnum

This method is used to verify that clients can round-trip enum values, which is particularly important for unknown enum values over REST. VerifyEnum() verifies that its request, which is presumably the response that the client previously got to a GetEnum(), contains the correct data. If so, it responds with the same EnumResponse; otherwise, the RPC errors. *

This works because the values of enums sent by the server when a known or unknown value is requested will be the same within a single Showcase server run, although they are not guaranteed to be the same across separate Showcase server runs.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • verifyEnum(EnumResponse request) + *

  • verifyEnum(EnumResponse request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • verifyEnumCallable() + *

  • verifyEnumCallable() *

*
ListLocations

ListLocations

Lists information about the supported locations for this service.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listLocations(ListLocationsRequest request) + *

  • listLocations(ListLocationsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listLocationsPagedCallable() - *
  • listLocationsCallable() + *

  • listLocationsPagedCallable() + *

  • listLocationsCallable() *

*
GetLocation

GetLocation

Gets information about a location.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getLocation(GetLocationRequest request) + *

  • getLocation(GetLocationRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getLocationCallable() + *

  • getLocationCallable() *

*
SetIamPolicy

SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • setIamPolicy(SetIamPolicyRequest request) + *

  • setIamPolicy(SetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • setIamPolicyCallable() + *

  • setIamPolicyCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
TestIamPermissions

TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. *

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
* *

See the individual methods for example code. diff --git a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/EchoClient.java b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/EchoClient.java index f2aa7eee98..804b52dc29 100644 --- a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/EchoClient.java +++ b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/EchoClient.java @@ -84,215 +84,216 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
Echo

Echo

This method simply echoes the request. This method showcases unary RPCs.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • echo(EchoRequest request) + *

  • echo(EchoRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • echoCallable() + *

  • echoCallable() *

*
EchoErrorDetails

EchoErrorDetails

This method returns error details in a repeated "google.protobuf.Any" field. This method showcases handling errors thus encoded, particularly over REST transport. Note that GAPICs only allow the type "google.protobuf.Any" for field paths ending in "error.details", and, at run-time, the actual types for these fields must be one of the types in google/rpc/error_details.proto.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • echoErrorDetails(EchoErrorDetailsRequest request) + *

  • echoErrorDetails(EchoErrorDetailsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • echoErrorDetailsCallable() + *

  • echoErrorDetailsCallable() *

*
Expand

Expand

This method splits the given content into words and will pass each word back through the stream. This method showcases server-side streaming RPCs.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • expandCallable() + *

  • expandCallable() *

*
Collect

Collect

This method will collect the words given to it. When the stream is closed by the client, this method will return the a concatenation of the strings passed to it. This method showcases client-side streaming RPCs.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • collectCallable() + *

  • collectCallable() *

*
Chat

Chat

This method, upon receiving a request on the stream, will pass the same content back on the stream. This method showcases bidirectional streaming RPCs.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • chatCallable() + *

  • chatCallable() *

*
PagedExpand

PagedExpand

This is similar to the Expand method but instead of returning a stream of expanded words, this method returns a paged list of expanded words.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • pagedExpand(PagedExpandRequest request) + *

  • pagedExpand(PagedExpandRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • pagedExpandPagedCallable() - *
  • pagedExpandCallable() + *

  • pagedExpandPagedCallable() + *

  • pagedExpandCallable() *

*
PagedExpandLegacy

PagedExpandLegacy

This is similar to the PagedExpand except that it uses max_results instead of page_size, as some legacy APIs still do. New APIs should NOT use this pattern.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • pagedExpandLegacy(PagedExpandLegacyRequest request) + *

  • pagedExpandLegacy(PagedExpandLegacyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • pagedExpandLegacyCallable() + *

  • pagedExpandLegacyCallable() *

*
PagedExpandLegacyMapped

PagedExpandLegacyMapped

This method returns a map containing lists of words that appear in the input, keyed by their initial character. The only words returned are the ones included in the current page, as determined by page_token and page_size, which both refer to the word indices in the input. This paging result consisting of a map of lists is a pattern used by some legacy APIs. New APIs should NOT use this pattern.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • pagedExpandLegacyMapped(PagedExpandRequest request) + *

  • pagedExpandLegacyMapped(PagedExpandRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • pagedExpandLegacyMappedPagedCallable() - *
  • pagedExpandLegacyMappedCallable() + *

  • pagedExpandLegacyMappedPagedCallable() + *

  • pagedExpandLegacyMappedCallable() *

*
Wait

Wait

This method will wait for the requested amount of time and then return. This method showcases how a client handles a request timeout.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • waitAsync(WaitRequest request) + *

  • waitAsync(WaitRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • waitOperationCallable() - *
  • waitCallable() + *

  • waitOperationCallable() + *

  • waitCallable() *

*
Block

Block

This method will block (wait) for the requested amount of time and then return the response or error. This method showcases how a client handles delays or retries.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • block(BlockRequest request) + *

  • block(BlockRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • blockCallable() + *

  • blockCallable() *

*
ListLocations

ListLocations

Lists information about the supported locations for this service.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listLocations(ListLocationsRequest request) + *

  • listLocations(ListLocationsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listLocationsPagedCallable() - *
  • listLocationsCallable() + *

  • listLocationsPagedCallable() + *

  • listLocationsCallable() *

*
GetLocation

GetLocation

Gets information about a location.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getLocation(GetLocationRequest request) + *

  • getLocation(GetLocationRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getLocationCallable() + *

  • getLocationCallable() *

*
SetIamPolicy

SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • setIamPolicy(SetIamPolicyRequest request) + *

  • setIamPolicy(SetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • setIamPolicyCallable() + *

  • setIamPolicyCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
TestIamPermissions

TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. *

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
* *

See the individual methods for example code. diff --git a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/IdentityClient.java b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/IdentityClient.java index c098a4bd44..e26fb08281 100644 --- a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/IdentityClient.java +++ b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/IdentityClient.java @@ -67,170 +67,171 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
CreateUser

CreateUser

Creates a user.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createUser(CreateUserRequest request) + *

  • createUser(CreateUserRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createUser(String displayName, String email) - *
  • createUser(String displayName, String email, int age, String nickname, boolean enableNotifications, double heightFeet) + *

  • createUser(String displayName, String email) + *

  • createUser(String displayName, String email, int age, String nickname, boolean enableNotifications, double heightFeet) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createUserCallable() + *

  • createUserCallable() *

*
GetUser

GetUser

Retrieves the User with the given uri.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getUser(GetUserRequest request) + *

  • getUser(GetUserRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getUser(UserName name) - *
  • getUser(String name) + *

  • getUser(UserName name) + *

  • getUser(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getUserCallable() + *

  • getUserCallable() *

*
UpdateUser

UpdateUser

Updates a user.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateUser(UpdateUserRequest request) + *

  • updateUser(UpdateUserRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateUserCallable() + *

  • updateUserCallable() *

*
DeleteUser

DeleteUser

Deletes a user, their profile, and all of their authored messages.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteUser(DeleteUserRequest request) + *

  • deleteUser(DeleteUserRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteUser(UserName name) - *
  • deleteUser(String name) + *

  • deleteUser(UserName name) + *

  • deleteUser(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteUserCallable() + *

  • deleteUserCallable() *

*
ListUsers

ListUsers

Lists all users.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listUsers(ListUsersRequest request) + *

  • listUsers(ListUsersRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listUsersPagedCallable() - *
  • listUsersCallable() + *

  • listUsersPagedCallable() + *

  • listUsersCallable() *

*
ListLocations

ListLocations

Lists information about the supported locations for this service.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listLocations(ListLocationsRequest request) + *

  • listLocations(ListLocationsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listLocationsPagedCallable() - *
  • listLocationsCallable() + *

  • listLocationsPagedCallable() + *

  • listLocationsCallable() *

*
GetLocation

GetLocation

Gets information about a location.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getLocation(GetLocationRequest request) + *

  • getLocation(GetLocationRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getLocationCallable() + *

  • getLocationCallable() *

*
SetIamPolicy

SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • setIamPolicy(SetIamPolicyRequest request) + *

  • setIamPolicy(SetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • setIamPolicyCallable() + *

  • setIamPolicyCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
TestIamPermissions

TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. *

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
* *

See the individual methods for example code. diff --git a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/MessagingClient.java b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/MessagingClient.java index 24fc2e7dd2..f2cb5e4d7d 100644 --- a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/MessagingClient.java +++ b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/MessagingClient.java @@ -78,322 +78,323 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
CreateRoom

CreateRoom

Creates a room.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createRoom(CreateRoomRequest request) + *

  • createRoom(CreateRoomRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createRoom(String displayName, String description) + *

  • createRoom(String displayName, String description) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createRoomCallable() + *

  • createRoomCallable() *

*
GetRoom

GetRoom

Retrieves the Room with the given resource name.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getRoom(GetRoomRequest request) + *

  • getRoom(GetRoomRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getRoom(RoomName name) - *
  • getRoom(String name) + *

  • getRoom(RoomName name) + *

  • getRoom(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getRoomCallable() + *

  • getRoomCallable() *

*
UpdateRoom

UpdateRoom

Updates a room.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateRoom(UpdateRoomRequest request) + *

  • updateRoom(UpdateRoomRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateRoomCallable() + *

  • updateRoomCallable() *

*
DeleteRoom

DeleteRoom

Deletes a room and all of its blurbs.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteRoom(DeleteRoomRequest request) + *

  • deleteRoom(DeleteRoomRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteRoom(RoomName name) - *
  • deleteRoom(String name) + *

  • deleteRoom(RoomName name) + *

  • deleteRoom(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteRoomCallable() + *

  • deleteRoomCallable() *

*
ListRooms

ListRooms

Lists all chat rooms.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listRooms(ListRoomsRequest request) + *

  • listRooms(ListRoomsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listRoomsPagedCallable() - *
  • listRoomsCallable() + *

  • listRoomsPagedCallable() + *

  • listRoomsCallable() *

*
CreateBlurb

CreateBlurb

Creates a blurb. If the parent is a room, the blurb is understood to be a message in that room. If the parent is a profile, the blurb is understood to be a post on the profile.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createBlurb(CreateBlurbRequest request) + *

  • createBlurb(CreateBlurbRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createBlurb(ProfileName parent, UserName user, ByteString image) - *
  • createBlurb(ProfileName parent, UserName user, String text) - *
  • createBlurb(ProfileName parent, String user, ByteString image) - *
  • createBlurb(ProfileName parent, String user, String text) - *
  • createBlurb(RoomName parent, UserName user, ByteString image) - *
  • createBlurb(RoomName parent, UserName user, String text) - *
  • createBlurb(RoomName parent, String user, ByteString image) - *
  • createBlurb(RoomName parent, String user, String text) - *
  • createBlurb(String parent, UserName user, ByteString image) - *
  • createBlurb(String parent, UserName user, String text) - *
  • createBlurb(String parent, String user, ByteString image) - *
  • createBlurb(String parent, String user, String text) + *

  • createBlurb(ProfileName parent, UserName user, ByteString image) + *

  • createBlurb(ProfileName parent, UserName user, String text) + *

  • createBlurb(ProfileName parent, String user, ByteString image) + *

  • createBlurb(ProfileName parent, String user, String text) + *

  • createBlurb(RoomName parent, UserName user, ByteString image) + *

  • createBlurb(RoomName parent, UserName user, String text) + *

  • createBlurb(RoomName parent, String user, ByteString image) + *

  • createBlurb(RoomName parent, String user, String text) + *

  • createBlurb(String parent, UserName user, ByteString image) + *

  • createBlurb(String parent, UserName user, String text) + *

  • createBlurb(String parent, String user, ByteString image) + *

  • createBlurb(String parent, String user, String text) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createBlurbCallable() + *

  • createBlurbCallable() *

*
GetBlurb

GetBlurb

Retrieves the Blurb with the given resource name.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getBlurb(GetBlurbRequest request) + *

  • getBlurb(GetBlurbRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getBlurb(BlurbName name) - *
  • getBlurb(String name) + *

  • getBlurb(BlurbName name) + *

  • getBlurb(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getBlurbCallable() + *

  • getBlurbCallable() *

*
UpdateBlurb

UpdateBlurb

Updates a blurb.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateBlurb(UpdateBlurbRequest request) + *

  • updateBlurb(UpdateBlurbRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateBlurbCallable() + *

  • updateBlurbCallable() *

*
DeleteBlurb

DeleteBlurb

Deletes a blurb.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteBlurb(DeleteBlurbRequest request) + *

  • deleteBlurb(DeleteBlurbRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteBlurb(BlurbName name) - *
  • deleteBlurb(String name) + *

  • deleteBlurb(BlurbName name) + *

  • deleteBlurb(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteBlurbCallable() + *

  • deleteBlurbCallable() *

*
ListBlurbs

ListBlurbs

Lists blurbs for a specific chat room or user profile depending on the parent resource name.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listBlurbs(ListBlurbsRequest request) + *

  • listBlurbs(ListBlurbsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listBlurbs(ProfileName parent) - *
  • listBlurbs(RoomName parent) - *
  • listBlurbs(String parent) + *

  • listBlurbs(ProfileName parent) + *

  • listBlurbs(RoomName parent) + *

  • listBlurbs(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listBlurbsPagedCallable() - *
  • listBlurbsCallable() + *

  • listBlurbsPagedCallable() + *

  • listBlurbsCallable() *

*
SearchBlurbs

SearchBlurbs

This method searches through all blurbs across all rooms and profiles for blurbs containing to words found in the query. Only posts that contain an exact match of a queried word will be returned.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • searchBlurbsAsync(SearchBlurbsRequest request) + *

  • searchBlurbsAsync(SearchBlurbsRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • searchBlurbsAsync(ProfileName parent, String query) - *
  • searchBlurbsAsync(RoomName parent, String query) - *
  • searchBlurbsAsync(String parent, String query) + *

  • searchBlurbsAsync(ProfileName parent, String query) + *

  • searchBlurbsAsync(RoomName parent, String query) + *

  • searchBlurbsAsync(String parent, String query) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • searchBlurbsOperationCallable() - *
  • searchBlurbsCallable() + *

  • searchBlurbsOperationCallable() + *

  • searchBlurbsCallable() *

*
StreamBlurbs

StreamBlurbs

This returns a stream that emits the blurbs that are created for a particular chat room or user profile.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • streamBlurbsCallable() + *

  • streamBlurbsCallable() *

*
SendBlurbs

SendBlurbs

This is a stream to create multiple blurbs. If an invalid blurb is requested to be created, the stream will close with an error.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • sendBlurbsCallable() + *

  • sendBlurbsCallable() *

*
Connect

Connect

This method starts a bidirectional stream that receives all blurbs that are being created after the stream has started and sends requests to create blurbs. If an invalid blurb is requested to be created, the stream will close with an error.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • connectCallable() + *

  • connectCallable() *

*
ListLocations

ListLocations

Lists information about the supported locations for this service.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listLocations(ListLocationsRequest request) + *

  • listLocations(ListLocationsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listLocationsPagedCallable() - *
  • listLocationsCallable() + *

  • listLocationsPagedCallable() + *

  • listLocationsCallable() *

*
GetLocation

GetLocation

Gets information about a location.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getLocation(GetLocationRequest request) + *

  • getLocation(GetLocationRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getLocationCallable() + *

  • getLocationCallable() *

*
SetIamPolicy

SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • setIamPolicy(SetIamPolicyRequest request) + *

  • setIamPolicy(SetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • setIamPolicyCallable() + *

  • setIamPolicyCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
TestIamPermissions

TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. *

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
* *

See the individual methods for example code. diff --git a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/SequenceServiceClient.java b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/SequenceServiceClient.java index 8411c68c13..7436214060 100644 --- a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/SequenceServiceClient.java +++ b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/SequenceServiceClient.java @@ -66,187 +66,188 @@ * close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
CreateSequence

CreateSequence

Creates a sequence.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createSequence(CreateSequenceRequest request) + *

  • createSequence(CreateSequenceRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createSequence(Sequence sequence) + *

  • createSequence(Sequence sequence) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createSequenceCallable() + *

  • createSequenceCallable() *

*
CreateStreamingSequence

CreateStreamingSequence

Creates a sequence.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createStreamingSequence(CreateStreamingSequenceRequest request) + *

  • createStreamingSequence(CreateStreamingSequenceRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createStreamingSequence(StreamingSequence streamingSequence) + *

  • createStreamingSequence(StreamingSequence streamingSequence) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createStreamingSequenceCallable() + *

  • createStreamingSequenceCallable() *

*
GetSequenceReport

GetSequenceReport

Retrieves a sequence.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getSequenceReport(GetSequenceReportRequest request) + *

  • getSequenceReport(GetSequenceReportRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getSequenceReport(SequenceReportName name) - *
  • getSequenceReport(String name) + *

  • getSequenceReport(SequenceReportName name) + *

  • getSequenceReport(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getSequenceReportCallable() + *

  • getSequenceReportCallable() *

*
GetStreamingSequenceReport

GetStreamingSequenceReport

Retrieves a sequence.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getStreamingSequenceReport(GetStreamingSequenceReportRequest request) + *

  • getStreamingSequenceReport(GetStreamingSequenceReportRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getStreamingSequenceReport(StreamingSequenceReportName name) - *
  • getStreamingSequenceReport(String name) + *

  • getStreamingSequenceReport(StreamingSequenceReportName name) + *

  • getStreamingSequenceReport(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getStreamingSequenceReportCallable() + *

  • getStreamingSequenceReportCallable() *

*
AttemptSequence

AttemptSequence

Attempts a sequence.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • attemptSequence(AttemptSequenceRequest request) + *

  • attemptSequence(AttemptSequenceRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • attemptSequence(SequenceName name) - *
  • attemptSequence(String name) + *

  • attemptSequence(SequenceName name) + *

  • attemptSequence(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • attemptSequenceCallable() + *

  • attemptSequenceCallable() *

*
AttemptStreamingSequence

AttemptStreamingSequence

Attempts a streaming sequence.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • attemptStreamingSequenceCallable() + *

  • attemptStreamingSequenceCallable() *

*
ListLocations

ListLocations

Lists information about the supported locations for this service.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listLocations(ListLocationsRequest request) + *

  • listLocations(ListLocationsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listLocationsPagedCallable() - *
  • listLocationsCallable() + *

  • listLocationsPagedCallable() + *

  • listLocationsCallable() *

*
GetLocation

GetLocation

Gets information about a location.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getLocation(GetLocationRequest request) + *

  • getLocation(GetLocationRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getLocationCallable() + *

  • getLocationCallable() *

*
SetIamPolicy

SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • setIamPolicy(SetIamPolicyRequest request) + *

  • setIamPolicy(SetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • setIamPolicyCallable() + *

  • setIamPolicyCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
TestIamPermissions

TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. *

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
* *

See the individual methods for example code. diff --git a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/TestingClient.java b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/TestingClient.java index cebb83e0b7..15200b24e1 100644 --- a/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/TestingClient.java +++ b/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/TestingClient.java @@ -69,201 +69,202 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
CreateSession

CreateSession

Creates a new testing session. Adding this comment with special characters for comment formatting tests: 1. (abra->kadabra->alakazam) 2) [Nonsense][]: `pokemon/*/psychic/*`

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createSession(CreateSessionRequest request) + *

  • createSession(CreateSessionRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createSessionCallable() + *

  • createSessionCallable() *

*
GetSession

GetSession

Gets a testing session.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getSession(GetSessionRequest request) + *

  • getSession(GetSessionRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getSessionCallable() + *

  • getSessionCallable() *

*
ListSessions

ListSessions

Lists the current test sessions.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listSessions(ListSessionsRequest request) + *

  • listSessions(ListSessionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listSessionsPagedCallable() - *
  • listSessionsCallable() + *

  • listSessionsPagedCallable() + *

  • listSessionsCallable() *

*
DeleteSession

DeleteSession

Delete a test session.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteSession(DeleteSessionRequest request) + *

  • deleteSession(DeleteSessionRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteSessionCallable() + *

  • deleteSessionCallable() *

*
ReportSession

ReportSession

Report on the status of a session. This generates a report detailing which tests have been completed, and an overall rollup.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • reportSession(ReportSessionRequest request) + *

  • reportSession(ReportSessionRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • reportSessionCallable() + *

  • reportSessionCallable() *

*
ListTests

ListTests

List the tests of a sessesion.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listTests(ListTestsRequest request) + *

  • listTests(ListTestsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listTestsPagedCallable() - *
  • listTestsCallable() + *

  • listTestsPagedCallable() + *

  • listTestsCallable() *

*
DeleteTest

DeleteTest

Explicitly decline to implement a test. *

This removes the test from subsequent `ListTests` calls, and attempting to do the test will error. *

This method will error if attempting to delete a required test.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteTest(DeleteTestRequest request) + *

  • deleteTest(DeleteTestRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteTestCallable() + *

  • deleteTestCallable() *

*
VerifyTest

VerifyTest

Register a response to a test. *

In cases where a test involves registering a final answer at the end of the test, this method provides the means to do so.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • verifyTest(VerifyTestRequest request) + *

  • verifyTest(VerifyTestRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • verifyTestCallable() + *

  • verifyTestCallable() *

*
ListLocations

ListLocations

Lists information about the supported locations for this service.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listLocations(ListLocationsRequest request) + *

  • listLocations(ListLocationsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listLocationsPagedCallable() - *
  • listLocationsCallable() + *

  • listLocationsPagedCallable() + *

  • listLocationsCallable() *

*
GetLocation

GetLocation

Gets information about a location.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getLocation(GetLocationRequest request) + *

  • getLocation(GetLocationRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getLocationCallable() + *

  • getLocationCallable() *

*
SetIamPolicy

SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • setIamPolicy(SetIamPolicyRequest request) + *

  • setIamPolicy(SetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • setIamPolicyCallable() + *

  • setIamPolicyCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
TestIamPermissions

TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. *

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/apigeeconnect/src/com/google/cloud/apigeeconnect/v1/ConnectionServiceClient.java b/test/integration/goldens/apigeeconnect/src/com/google/cloud/apigeeconnect/v1/ConnectionServiceClient.java index 691af68c69..c1be2a6a0b 100644 --- a/test/integration/goldens/apigeeconnect/src/com/google/cloud/apigeeconnect/v1/ConnectionServiceClient.java +++ b/test/integration/goldens/apigeeconnect/src/com/google/cloud/apigeeconnect/v1/ConnectionServiceClient.java @@ -58,31 +58,32 @@ * close(). * * + * * * * * + * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
ListConnections

ListConnections

Lists connections that are currently active for the given Apigee Connect endpoint.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listConnections(ListConnectionsRequest request) + *

  • listConnections(ListConnectionsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listConnections(EndpointName parent) - *
  • listConnections(String parent) + *

  • listConnections(EndpointName parent) + *

  • listConnections(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listConnectionsPagedCallable() - *
  • listConnectionsCallable() + *

  • listConnectionsPagedCallable() + *

  • listConnectionsCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/apigeeconnect/src/com/google/cloud/apigeeconnect/v1/TetherClient.java b/test/integration/goldens/apigeeconnect/src/com/google/cloud/apigeeconnect/v1/TetherClient.java index 587dff88f0..5e7dc7150d 100644 --- a/test/integration/goldens/apigeeconnect/src/com/google/cloud/apigeeconnect/v1/TetherClient.java +++ b/test/integration/goldens/apigeeconnect/src/com/google/cloud/apigeeconnect/v1/TetherClient.java @@ -62,21 +62,22 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
Egress

Egress

Egress streams egress requests and responses. Logically, this is not actually a streaming request, but uses streaming as a mechanism to flip the client-server relationship of gRPC so that the server can act as a client. The listener, the RPC server, accepts connections from the dialer, the RPC client. The listener streams http requests and the dialer streams http responses.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • egressCallable() + *

  • egressCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/asset/src/com/google/cloud/asset/v1/AssetServiceClient.java b/test/integration/goldens/asset/src/com/google/cloud/asset/v1/AssetServiceClient.java index ff2b73883e..f163939bd0 100644 --- a/test/integration/goldens/asset/src/com/google/cloud/asset/v1/AssetServiceClient.java +++ b/test/integration/goldens/asset/src/com/google/cloud/asset/v1/AssetServiceClient.java @@ -70,234 +70,236 @@ * as threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
ExportAssets

ExportAssets

Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a [google.cloud.asset.v1.Asset][google.cloud.asset.v1.Asset] in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf as columns. This API implements the [google.longrunning.Operation][google.longrunning.Operation] API, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • exportAssetsAsync(ExportAssetsRequest request) + *

  • exportAssetsAsync(ExportAssetsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • exportAssetsOperationCallable() - *
  • exportAssetsCallable() + *

  • exportAssetsOperationCallable() + *

  • exportAssetsCallable() *

*
ListAssets

ListAssets

Lists assets with time and resource types and returns paged results in response.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listAssets(ListAssetsRequest request) + *

  • listAssets(ListAssetsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listAssets(ResourceName parent) - *
  • listAssets(String parent) + *

  • listAssets(ResourceName parent) + *

  • listAssets(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listAssetsPagedCallable() - *
  • listAssetsCallable() + *

  • listAssetsPagedCallable() + *

  • listAssetsCallable() *

*
BatchGetAssetsHistory

BatchGetAssetsHistory

Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • batchGetAssetsHistory(BatchGetAssetsHistoryRequest request) + *

  • batchGetAssetsHistory(BatchGetAssetsHistoryRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • batchGetAssetsHistoryCallable() + *

  • batchGetAssetsHistoryCallable() *

*
CreateFeed

CreateFeed

Creates a feed in a parent project/folder/organization to listen to its asset updates.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createFeed(CreateFeedRequest request) + *

  • createFeed(CreateFeedRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createFeed(String parent) + *

  • createFeed(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createFeedCallable() + *

  • createFeedCallable() *

*
GetFeed

GetFeed

Gets details about an asset feed.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getFeed(GetFeedRequest request) + *

  • getFeed(GetFeedRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getFeed(FeedName name) - *
  • getFeed(String name) + *

  • getFeed(FeedName name) + *

  • getFeed(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getFeedCallable() + *

  • getFeedCallable() *

*
ListFeeds

ListFeeds

Lists all asset feeds in a parent project/folder/organization.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listFeeds(ListFeedsRequest request) + *

  • listFeeds(ListFeedsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listFeeds(String parent) + *

  • listFeeds(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listFeedsCallable() + *

  • listFeedsCallable() *

*
UpdateFeed

UpdateFeed

Updates an asset feed configuration.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateFeed(UpdateFeedRequest request) + *

  • updateFeed(UpdateFeedRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateFeed(Feed feed) + *

  • updateFeed(Feed feed) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateFeedCallable() + *

  • updateFeedCallable() *

*
DeleteFeed

DeleteFeed

Deletes an asset feed.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteFeed(DeleteFeedRequest request) + *

  • deleteFeed(DeleteFeedRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteFeed(FeedName name) - *
  • deleteFeed(String name) + *

  • deleteFeed(FeedName name) + *

  • deleteFeed(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteFeedCallable() + *

  • deleteFeedCallable() *

*
SearchAllResources

SearchAllResources

Searches all Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllResources` permission on the desired scope, otherwise the request will be rejected.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • searchAllResources(SearchAllResourcesRequest request) + *

  • searchAllResources(SearchAllResourcesRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • searchAllResources(String scope, String query, List assetTypes) + *

  • searchAllResources(String scope, String query, List<String> assetTypes) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • searchAllResourcesPagedCallable() - *
  • searchAllResourcesCallable() + *

  • searchAllResourcesPagedCallable() + *

  • searchAllResourcesCallable() *

*
SearchAllIamPolicies

SearchAllIamPolicies

Searches all IAM policies within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllIamPolicies` permission on the desired scope, otherwise the request will be rejected.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • searchAllIamPolicies(SearchAllIamPoliciesRequest request) + *

  • searchAllIamPolicies(SearchAllIamPoliciesRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • searchAllIamPolicies(String scope, String query) + *

  • searchAllIamPolicies(String scope, String query) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • searchAllIamPoliciesPagedCallable() - *
  • searchAllIamPoliciesCallable() + *

  • searchAllIamPoliciesPagedCallable() + *

  • searchAllIamPoliciesCallable() *

*
AnalyzeIamPolicy

AnalyzeIamPolicy

Analyzes IAM policies to answer which identities have what accesses on which resources.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • analyzeIamPolicy(AnalyzeIamPolicyRequest request) + *

  • analyzeIamPolicy(AnalyzeIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • analyzeIamPolicyCallable() + *

  • analyzeIamPolicyCallable() *

*
AnalyzeIamPolicyLongrunning

AnalyzeIamPolicyLongrunning

Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a [AnalyzeIamPolicyResponse][google.cloud.asset.v1.AnalyzeIamPolicyResponse]. This method implements the [google.longrunning.Operation][google.longrunning.Operation], which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the metadata for the long-running operation.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • analyzeIamPolicyLongrunningAsync(AnalyzeIamPolicyLongrunningRequest request) + *

  • analyzeIamPolicyLongrunningAsync(AnalyzeIamPolicyLongrunningRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • analyzeIamPolicyLongrunningOperationCallable() - *
  • analyzeIamPolicyLongrunningCallable() + *

  • analyzeIamPolicyLongrunningOperationCallable() + *

  • analyzeIamPolicyLongrunningCallable() *

*
AnalyzeMove

AnalyzeMove

Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user's permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • analyzeMove(AnalyzeMoveRequest request) + *

  • analyzeMove(AnalyzeMoveRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • analyzeMoveCallable() + *

  • analyzeMoveCallable() *

*
QueryAssets

QueryAssets

Issue a job that queries assets using a SQL statement compatible with [BigQuery Standard SQL](http://cloud/bigquery/docs/reference/standard-sql/enabling-standard-sql). *

If the query execution finishes within timeout and there's no pagination, the full query results will be returned in the `QueryAssetsResponse`. *

Otherwise, full query results can be obtained by issuing extra requests with the `job_reference` from the a previous `QueryAssets` call. @@ -305,128 +307,127 @@ *

*

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • queryAssets(QueryAssetsRequest request) + *

  • queryAssets(QueryAssetsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • queryAssetsCallable() + *

  • queryAssetsCallable() *

*
CreateSavedQuery

CreateSavedQuery

Creates a saved query in a parent project/folder/organization.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createSavedQuery(CreateSavedQueryRequest request) + *

  • createSavedQuery(CreateSavedQueryRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createSavedQuery(FolderName parent, SavedQuery savedQuery, String savedQueryId) - *
  • createSavedQuery(OrganizationName parent, SavedQuery savedQuery, String savedQueryId) - *
  • createSavedQuery(ProjectName parent, SavedQuery savedQuery, String savedQueryId) - *
  • createSavedQuery(String parent, SavedQuery savedQuery, String savedQueryId) + *

  • createSavedQuery(FolderName parent, SavedQuery savedQuery, String savedQueryId) + *

  • createSavedQuery(OrganizationName parent, SavedQuery savedQuery, String savedQueryId) + *

  • createSavedQuery(ProjectName parent, SavedQuery savedQuery, String savedQueryId) + *

  • createSavedQuery(String parent, SavedQuery savedQuery, String savedQueryId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createSavedQueryCallable() + *

  • createSavedQueryCallable() *

*
GetSavedQuery

GetSavedQuery

Gets details about a saved query.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getSavedQuery(GetSavedQueryRequest request) + *

  • getSavedQuery(GetSavedQueryRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getSavedQuery(SavedQueryName name) - *
  • getSavedQuery(String name) + *

  • getSavedQuery(SavedQueryName name) + *

  • getSavedQuery(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getSavedQueryCallable() + *

  • getSavedQueryCallable() *

*
ListSavedQueries

ListSavedQueries

Lists all saved queries in a parent project/folder/organization.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listSavedQueries(ListSavedQueriesRequest request) + *

  • listSavedQueries(ListSavedQueriesRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listSavedQueries(FolderName parent) - *
  • listSavedQueries(OrganizationName parent) - *
  • listSavedQueries(ProjectName parent) - *
  • listSavedQueries(String parent) + *

  • listSavedQueries(FolderName parent) + *

  • listSavedQueries(OrganizationName parent) + *

  • listSavedQueries(ProjectName parent) + *

  • listSavedQueries(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listSavedQueriesPagedCallable() - *
  • listSavedQueriesCallable() + *

  • listSavedQueriesPagedCallable() + *

  • listSavedQueriesCallable() *

*
UpdateSavedQuery

UpdateSavedQuery

Updates a saved query.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateSavedQuery(UpdateSavedQueryRequest request) + *

  • updateSavedQuery(UpdateSavedQueryRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateSavedQuery(SavedQuery savedQuery, FieldMask updateMask) + *

  • updateSavedQuery(SavedQuery savedQuery, FieldMask updateMask) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateSavedQueryCallable() + *

  • updateSavedQueryCallable() *

*
DeleteSavedQuery

DeleteSavedQuery

Deletes a saved query.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteSavedQuery(DeleteSavedQueryRequest request) + *

  • deleteSavedQuery(DeleteSavedQueryRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteSavedQuery(SavedQueryName name) - *
  • deleteSavedQuery(String name) + *

  • deleteSavedQuery(SavedQueryName name) + *

  • deleteSavedQuery(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteSavedQueryCallable() + *

  • deleteSavedQueryCallable() *

*
BatchGetEffectiveIamPolicies

BatchGetEffectiveIamPolicies

Gets effective IAM policies for a batch of resources.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • batchGetEffectiveIamPolicies(BatchGetEffectiveIamPoliciesRequest request) + *

  • batchGetEffectiveIamPolicies(BatchGetEffectiveIamPoliciesRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • batchGetEffectiveIamPoliciesCallable() + *

  • batchGetEffectiveIamPoliciesCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/bigtable/src/com/google/cloud/bigtable/data/v2/BaseBigtableDataClient.java b/test/integration/goldens/bigtable/src/com/google/cloud/bigtable/data/v2/BaseBigtableDataClient.java index 46e3f7c73b..ec522bcc51 100644 --- a/test/integration/goldens/bigtable/src/com/google/cloud/bigtable/data/v2/BaseBigtableDataClient.java +++ b/test/integration/goldens/bigtable/src/com/google/cloud/bigtable/data/v2/BaseBigtableDataClient.java @@ -72,125 +72,126 @@ * close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
ReadRows

ReadRows

Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each. Depending on their size, rows and cells may be broken up across multiple responses, but atomicity of each row will still be preserved. See the ReadRowsResponse documentation for details.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • readRowsCallable() + *

  • readRowsCallable() *

*
SampleRowKeys

SampleRowKeys

Returns a sample of row keys in the table. The returned row keys will delimit contiguous sections of the table of approximately equal size, which can be used to break up the data for distributed tasks like mapreduces.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • sampleRowKeysCallable() + *

  • sampleRowKeysCallable() *

*
MutateRow

MutateRow

Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by `mutation`.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • mutateRow(MutateRowRequest request) + *

  • mutateRow(MutateRowRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • mutateRow(TableName tableName, ByteString rowKey, List mutations) - *
  • mutateRow(String tableName, ByteString rowKey, List mutations) - *
  • mutateRow(TableName tableName, ByteString rowKey, List mutations, String appProfileId) - *
  • mutateRow(String tableName, ByteString rowKey, List mutations, String appProfileId) + *

  • mutateRow(TableName tableName, ByteString rowKey, List<Mutation> mutations) + *

  • mutateRow(String tableName, ByteString rowKey, List<Mutation> mutations) + *

  • mutateRow(TableName tableName, ByteString rowKey, List<Mutation> mutations, String appProfileId) + *

  • mutateRow(String tableName, ByteString rowKey, List<Mutation> mutations, String appProfileId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • mutateRowCallable() + *

  • mutateRowCallable() *

*
MutateRows

MutateRows

Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • mutateRowsCallable() + *

  • mutateRowsCallable() *

*
CheckAndMutateRow

CheckAndMutateRow

Mutates a row atomically based on the output of a predicate Reader filter.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • checkAndMutateRow(CheckAndMutateRowRequest request) + *

  • checkAndMutateRow(CheckAndMutateRowRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • checkAndMutateRow(TableName tableName, ByteString rowKey, RowFilter predicateFilter, List trueMutations, List falseMutations) - *
  • checkAndMutateRow(String tableName, ByteString rowKey, RowFilter predicateFilter, List trueMutations, List falseMutations) - *
  • checkAndMutateRow(TableName tableName, ByteString rowKey, RowFilter predicateFilter, List trueMutations, List falseMutations, String appProfileId) - *
  • checkAndMutateRow(String tableName, ByteString rowKey, RowFilter predicateFilter, List trueMutations, List falseMutations, String appProfileId) + *

  • checkAndMutateRow(TableName tableName, ByteString rowKey, RowFilter predicateFilter, List<Mutation> trueMutations, List<Mutation> falseMutations) + *

  • checkAndMutateRow(String tableName, ByteString rowKey, RowFilter predicateFilter, List<Mutation> trueMutations, List<Mutation> falseMutations) + *

  • checkAndMutateRow(TableName tableName, ByteString rowKey, RowFilter predicateFilter, List<Mutation> trueMutations, List<Mutation> falseMutations, String appProfileId) + *

  • checkAndMutateRow(String tableName, ByteString rowKey, RowFilter predicateFilter, List<Mutation> trueMutations, List<Mutation> falseMutations, String appProfileId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • checkAndMutateRowCallable() + *

  • checkAndMutateRowCallable() *

*
PingAndWarm

PingAndWarm

Warm up associated instance metadata for this connection. This call is not required but may be useful for connection keep-alive.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • pingAndWarm(PingAndWarmRequest request) + *

  • pingAndWarm(PingAndWarmRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • pingAndWarm(InstanceName name) - *
  • pingAndWarm(String name) - *
  • pingAndWarm(InstanceName name, String appProfileId) - *
  • pingAndWarm(String name, String appProfileId) + *

  • pingAndWarm(InstanceName name) + *

  • pingAndWarm(String name) + *

  • pingAndWarm(InstanceName name, String appProfileId) + *

  • pingAndWarm(String name, String appProfileId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • pingAndWarmCallable() + *

  • pingAndWarmCallable() *

*
ReadModifyWriteRow

ReadModifyWriteRow

Modifies a row atomically on the server. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • readModifyWriteRow(ReadModifyWriteRowRequest request) + *

  • readModifyWriteRow(ReadModifyWriteRowRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • readModifyWriteRow(TableName tableName, ByteString rowKey, List rules) - *
  • readModifyWriteRow(String tableName, ByteString rowKey, List rules) - *
  • readModifyWriteRow(TableName tableName, ByteString rowKey, List rules, String appProfileId) - *
  • readModifyWriteRow(String tableName, ByteString rowKey, List rules, String appProfileId) + *

  • readModifyWriteRow(TableName tableName, ByteString rowKey, List<ReadModifyWriteRule> rules) + *

  • readModifyWriteRow(String tableName, ByteString rowKey, List<ReadModifyWriteRule> rules) + *

  • readModifyWriteRow(TableName tableName, ByteString rowKey, List<ReadModifyWriteRule> rules, String appProfileId) + *

  • readModifyWriteRow(String tableName, ByteString rowKey, List<ReadModifyWriteRule> rules, String appProfileId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • readModifyWriteRowCallable() + *

  • readModifyWriteRowCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/compute/src/com/google/cloud/compute/v1small/AddressesClient.java b/test/integration/goldens/compute/src/com/google/cloud/compute/v1small/AddressesClient.java index 0ab4f03a33..24966655e9 100644 --- a/test/integration/goldens/compute/src/com/google/cloud/compute/v1small/AddressesClient.java +++ b/test/integration/goldens/compute/src/com/google/cloud/compute/v1small/AddressesClient.java @@ -64,87 +64,88 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
AggregatedList

AggregatedList

Retrieves an aggregated list of addresses.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • aggregatedList(AggregatedListAddressesRequest request) + *

  • aggregatedList(AggregatedListAddressesRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • aggregatedList(String project) + *

  • aggregatedList(String project) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • aggregatedListPagedCallable() - *
  • aggregatedListCallable() + *

  • aggregatedListPagedCallable() + *

  • aggregatedListCallable() *

*
Delete

Delete

Deletes the specified address resource.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteAsync(DeleteAddressRequest request) + *

  • deleteAsync(DeleteAddressRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • deleteAsync(String project, String region, String address) + *

  • deleteAsync(String project, String region, String address) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteOperationCallable() - *
  • deleteCallable() + *

  • deleteOperationCallable() + *

  • deleteCallable() *

*
Insert

Insert

Creates an address resource in the specified project by using the data included in the request.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • insertAsync(InsertAddressRequest request) + *

  • insertAsync(InsertAddressRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • insertAsync(String project, String region, Address addressResource) + *

  • insertAsync(String project, String region, Address addressResource) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • insertOperationCallable() - *
  • insertCallable() + *

  • insertOperationCallable() + *

  • insertCallable() *

*
List

List

Retrieves a list of addresses contained within the specified region.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • list(ListAddressesRequest request) + *

  • list(ListAddressesRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • list(String project, String region, String orderBy) + *

  • list(String project, String region, String orderBy) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listPagedCallable() - *
  • listCallable() + *

  • listPagedCallable() + *

  • listCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/compute/src/com/google/cloud/compute/v1small/RegionOperationsClient.java b/test/integration/goldens/compute/src/com/google/cloud/compute/v1small/RegionOperationsClient.java index a11e550cc1..01e2795646 100644 --- a/test/integration/goldens/compute/src/com/google/cloud/compute/v1small/RegionOperationsClient.java +++ b/test/integration/goldens/compute/src/com/google/cloud/compute/v1small/RegionOperationsClient.java @@ -50,48 +50,49 @@ * close(). * * + * * * * * + * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
Get

Get

Retrieves the specified region-specific Operations resource.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • get(GetRegionOperationRequest request) + *

  • get(GetRegionOperationRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • get(String project, String region, String operation) + *

  • get(String project, String region, String operation) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getCallable() + *

  • getCallable() *

*
Wait

Wait

Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. *

This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • wait(WaitRegionOperationRequest request) + *

  • wait(WaitRegionOperationRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • wait(String project, String region, String operation) + *

  • wait(String project, String region, String operation) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • waitCallable() + *

  • waitCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/credentials/src/com/google/cloud/iam/credentials/v1/IamCredentialsClient.java b/test/integration/goldens/credentials/src/com/google/cloud/iam/credentials/v1/IamCredentialsClient.java index 18d7fa2837..d08dfc57b8 100644 --- a/test/integration/goldens/credentials/src/com/google/cloud/iam/credentials/v1/IamCredentialsClient.java +++ b/test/integration/goldens/credentials/src/com/google/cloud/iam/credentials/v1/IamCredentialsClient.java @@ -61,87 +61,88 @@ * as threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
GenerateAccessToken

GenerateAccessToken

Generates an OAuth 2.0 access token for a service account.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • generateAccessToken(GenerateAccessTokenRequest request) + *

  • generateAccessToken(GenerateAccessTokenRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • generateAccessToken(ServiceAccountName name, List delegates, List scope, Duration lifetime) - *
  • generateAccessToken(String name, List delegates, List scope, Duration lifetime) + *

  • generateAccessToken(ServiceAccountName name, List<String> delegates, List<String> scope, Duration lifetime) + *

  • generateAccessToken(String name, List<String> delegates, List<String> scope, Duration lifetime) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • generateAccessTokenCallable() + *

  • generateAccessTokenCallable() *

*
GenerateIdToken

GenerateIdToken

Generates an OpenID Connect ID token for a service account.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • generateIdToken(GenerateIdTokenRequest request) + *

  • generateIdToken(GenerateIdTokenRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • generateIdToken(ServiceAccountName name, List delegates, String audience, boolean includeEmail) - *
  • generateIdToken(String name, List delegates, String audience, boolean includeEmail) + *

  • generateIdToken(ServiceAccountName name, List<String> delegates, String audience, boolean includeEmail) + *

  • generateIdToken(String name, List<String> delegates, String audience, boolean includeEmail) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • generateIdTokenCallable() + *

  • generateIdTokenCallable() *

*
SignBlob

SignBlob

Signs a blob using a service account's system-managed private key.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • signBlob(SignBlobRequest request) + *

  • signBlob(SignBlobRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • signBlob(ServiceAccountName name, List delegates, ByteString payload) - *
  • signBlob(String name, List delegates, ByteString payload) + *

  • signBlob(ServiceAccountName name, List<String> delegates, ByteString payload) + *

  • signBlob(String name, List<String> delegates, ByteString payload) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • signBlobCallable() + *

  • signBlobCallable() *

*
SignJwt

SignJwt

Signs a JWT using a service account's system-managed private key.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • signJwt(SignJwtRequest request) + *

  • signJwt(SignJwtRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • signJwt(ServiceAccountName name, List delegates, String payload) - *
  • signJwt(String name, List delegates, String payload) + *

  • signJwt(ServiceAccountName name, List<String> delegates, String payload) + *

  • signJwt(String name, List<String> delegates, String payload) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • signJwtCallable() + *

  • signJwtCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/iam/src/com/google/iam/v1/IAMPolicyClient.java b/test/integration/goldens/iam/src/com/google/iam/v1/IAMPolicyClient.java index 07a45c57aa..8f874bfce1 100644 --- a/test/integration/goldens/iam/src/com/google/iam/v1/IAMPolicyClient.java +++ b/test/integration/goldens/iam/src/com/google/iam/v1/IAMPolicyClient.java @@ -73,55 +73,56 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
SetIamPolicy

SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • setIamPolicy(SetIamPolicyRequest request) + *

  • setIamPolicy(SetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • setIamPolicyCallable() + *

  • setIamPolicyCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
TestIamPermissions

TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. *

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/kms/src/com/google/cloud/kms/v1/KeyManagementServiceClient.java b/test/integration/goldens/kms/src/com/google/cloud/kms/v1/KeyManagementServiceClient.java index 766cc8f55c..fca416eecc 100644 --- a/test/integration/goldens/kms/src/com/google/cloud/kms/v1/KeyManagementServiceClient.java +++ b/test/integration/goldens/kms/src/com/google/cloud/kms/v1/KeyManagementServiceClient.java @@ -81,511 +81,512 @@ * calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
ListKeyRings

ListKeyRings

Lists [KeyRings][google.cloud.kms.v1.KeyRing].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listKeyRings(ListKeyRingsRequest request) + *

  • listKeyRings(ListKeyRingsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listKeyRings(LocationName parent) - *
  • listKeyRings(String parent) + *

  • listKeyRings(LocationName parent) + *

  • listKeyRings(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listKeyRingsPagedCallable() - *
  • listKeyRingsCallable() + *

  • listKeyRingsPagedCallable() + *

  • listKeyRingsCallable() *

*
ListCryptoKeys

ListCryptoKeys

Lists [CryptoKeys][google.cloud.kms.v1.CryptoKey].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listCryptoKeys(ListCryptoKeysRequest request) + *

  • listCryptoKeys(ListCryptoKeysRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listCryptoKeys(KeyRingName parent) - *
  • listCryptoKeys(String parent) + *

  • listCryptoKeys(KeyRingName parent) + *

  • listCryptoKeys(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listCryptoKeysPagedCallable() - *
  • listCryptoKeysCallable() + *

  • listCryptoKeysPagedCallable() + *

  • listCryptoKeysCallable() *

*
ListCryptoKeyVersions

ListCryptoKeyVersions

Lists [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listCryptoKeyVersions(ListCryptoKeyVersionsRequest request) + *

  • listCryptoKeyVersions(ListCryptoKeyVersionsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listCryptoKeyVersions(CryptoKeyName parent) - *
  • listCryptoKeyVersions(String parent) + *

  • listCryptoKeyVersions(CryptoKeyName parent) + *

  • listCryptoKeyVersions(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listCryptoKeyVersionsPagedCallable() - *
  • listCryptoKeyVersionsCallable() + *

  • listCryptoKeyVersionsPagedCallable() + *

  • listCryptoKeyVersionsCallable() *

*
ListImportJobs

ListImportJobs

Lists [ImportJobs][google.cloud.kms.v1.ImportJob].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listImportJobs(ListImportJobsRequest request) + *

  • listImportJobs(ListImportJobsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listImportJobs(KeyRingName parent) - *
  • listImportJobs(String parent) + *

  • listImportJobs(KeyRingName parent) + *

  • listImportJobs(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listImportJobsPagedCallable() - *
  • listImportJobsCallable() + *

  • listImportJobsPagedCallable() + *

  • listImportJobsCallable() *

*
GetKeyRing

GetKeyRing

Returns metadata for a given [KeyRing][google.cloud.kms.v1.KeyRing].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getKeyRing(GetKeyRingRequest request) + *

  • getKeyRing(GetKeyRingRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getKeyRing(KeyRingName name) - *
  • getKeyRing(String name) + *

  • getKeyRing(KeyRingName name) + *

  • getKeyRing(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getKeyRingCallable() + *

  • getKeyRingCallable() *

*
GetCryptoKey

GetCryptoKey

Returns metadata for a given [CryptoKey][google.cloud.kms.v1.CryptoKey], as well as its [primary][google.cloud.kms.v1.CryptoKey.primary] [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getCryptoKey(GetCryptoKeyRequest request) + *

  • getCryptoKey(GetCryptoKeyRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getCryptoKey(CryptoKeyName name) - *
  • getCryptoKey(String name) + *

  • getCryptoKey(CryptoKeyName name) + *

  • getCryptoKey(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getCryptoKeyCallable() + *

  • getCryptoKeyCallable() *

*
GetCryptoKeyVersion

GetCryptoKeyVersion

Returns metadata for a given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getCryptoKeyVersion(GetCryptoKeyVersionRequest request) + *

  • getCryptoKeyVersion(GetCryptoKeyVersionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getCryptoKeyVersion(CryptoKeyVersionName name) - *
  • getCryptoKeyVersion(String name) + *

  • getCryptoKeyVersion(CryptoKeyVersionName name) + *

  • getCryptoKeyVersion(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getCryptoKeyVersionCallable() + *

  • getCryptoKeyVersionCallable() *

*
GetPublicKey

GetPublicKey

Returns the public key for the given [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ASYMMETRIC_SIGN][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_SIGN] or [ASYMMETRIC_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ASYMMETRIC_DECRYPT].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getPublicKey(GetPublicKeyRequest request) + *

  • getPublicKey(GetPublicKeyRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getPublicKey(CryptoKeyVersionName name) - *
  • getPublicKey(String name) + *

  • getPublicKey(CryptoKeyVersionName name) + *

  • getPublicKey(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getPublicKeyCallable() + *

  • getPublicKeyCallable() *

*
GetImportJob

GetImportJob

Returns metadata for a given [ImportJob][google.cloud.kms.v1.ImportJob].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getImportJob(GetImportJobRequest request) + *

  • getImportJob(GetImportJobRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getImportJob(ImportJobName name) - *
  • getImportJob(String name) + *

  • getImportJob(ImportJobName name) + *

  • getImportJob(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getImportJobCallable() + *

  • getImportJobCallable() *

*
CreateKeyRing

CreateKeyRing

Create a new [KeyRing][google.cloud.kms.v1.KeyRing] in a given Project and Location.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createKeyRing(CreateKeyRingRequest request) + *

  • createKeyRing(CreateKeyRingRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createKeyRing(LocationName parent, String keyRingId, KeyRing keyRing) - *
  • createKeyRing(String parent, String keyRingId, KeyRing keyRing) + *

  • createKeyRing(LocationName parent, String keyRingId, KeyRing keyRing) + *

  • createKeyRing(String parent, String keyRingId, KeyRing keyRing) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createKeyRingCallable() + *

  • createKeyRingCallable() *

*
CreateCryptoKey

CreateCryptoKey

Create a new [CryptoKey][google.cloud.kms.v1.CryptoKey] within a [KeyRing][google.cloud.kms.v1.KeyRing]. *

[CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] and [CryptoKey.version_template.algorithm][google.cloud.kms.v1.CryptoKeyVersionTemplate.algorithm] are required.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createCryptoKey(CreateCryptoKeyRequest request) + *

  • createCryptoKey(CreateCryptoKeyRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createCryptoKey(KeyRingName parent, String cryptoKeyId, CryptoKey cryptoKey) - *
  • createCryptoKey(String parent, String cryptoKeyId, CryptoKey cryptoKey) + *

  • createCryptoKey(KeyRingName parent, String cryptoKeyId, CryptoKey cryptoKey) + *

  • createCryptoKey(String parent, String cryptoKeyId, CryptoKey cryptoKey) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createCryptoKeyCallable() + *

  • createCryptoKeyCallable() *

*
CreateCryptoKeyVersion

CreateCryptoKeyVersion

Create a new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in a [CryptoKey][google.cloud.kms.v1.CryptoKey]. *

The server will assign the next sequential id. If unset, [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createCryptoKeyVersion(CreateCryptoKeyVersionRequest request) + *

  • createCryptoKeyVersion(CreateCryptoKeyVersionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createCryptoKeyVersion(CryptoKeyName parent, CryptoKeyVersion cryptoKeyVersion) - *
  • createCryptoKeyVersion(String parent, CryptoKeyVersion cryptoKeyVersion) + *

  • createCryptoKeyVersion(CryptoKeyName parent, CryptoKeyVersion cryptoKeyVersion) + *

  • createCryptoKeyVersion(String parent, CryptoKeyVersion cryptoKeyVersion) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createCryptoKeyVersionCallable() + *

  • createCryptoKeyVersionCallable() *

*
ImportCryptoKeyVersion

ImportCryptoKeyVersion

Imports a new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] into an existing [CryptoKey][google.cloud.kms.v1.CryptoKey] using the wrapped key material provided in the request. *

The version ID will be assigned the next sequential id within the [CryptoKey][google.cloud.kms.v1.CryptoKey].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • importCryptoKeyVersion(ImportCryptoKeyVersionRequest request) + *

  • importCryptoKeyVersion(ImportCryptoKeyVersionRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • importCryptoKeyVersionCallable() + *

  • importCryptoKeyVersionCallable() *

*
CreateImportJob

CreateImportJob

Create a new [ImportJob][google.cloud.kms.v1.ImportJob] within a [KeyRing][google.cloud.kms.v1.KeyRing]. *

[ImportJob.import_method][google.cloud.kms.v1.ImportJob.import_method] is required.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createImportJob(CreateImportJobRequest request) + *

  • createImportJob(CreateImportJobRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createImportJob(KeyRingName parent, String importJobId, ImportJob importJob) - *
  • createImportJob(String parent, String importJobId, ImportJob importJob) + *

  • createImportJob(KeyRingName parent, String importJobId, ImportJob importJob) + *

  • createImportJob(String parent, String importJobId, ImportJob importJob) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createImportJobCallable() + *

  • createImportJobCallable() *

*
UpdateCryptoKey

UpdateCryptoKey

Update a [CryptoKey][google.cloud.kms.v1.CryptoKey].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateCryptoKey(UpdateCryptoKeyRequest request) + *

  • updateCryptoKey(UpdateCryptoKeyRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateCryptoKey(CryptoKey cryptoKey, FieldMask updateMask) + *

  • updateCryptoKey(CryptoKey cryptoKey, FieldMask updateMask) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateCryptoKeyCallable() + *

  • updateCryptoKeyCallable() *

*
UpdateCryptoKeyVersion

UpdateCryptoKeyVersion

Update a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s metadata. *

[state][google.cloud.kms.v1.CryptoKeyVersion.state] may be changed between [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED] and [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED] using this method. See [DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion] and [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] to move between other states.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateCryptoKeyVersion(UpdateCryptoKeyVersionRequest request) + *

  • updateCryptoKeyVersion(UpdateCryptoKeyVersionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateCryptoKeyVersion(CryptoKeyVersion cryptoKeyVersion, FieldMask updateMask) + *

  • updateCryptoKeyVersion(CryptoKeyVersion cryptoKeyVersion, FieldMask updateMask) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateCryptoKeyVersionCallable() + *

  • updateCryptoKeyVersionCallable() *

*
Encrypt

Encrypt

Encrypts data, so that it can only be recovered by a call to [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • encrypt(EncryptRequest request) + *

  • encrypt(EncryptRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • encrypt(ResourceName name, ByteString plaintext) - *
  • encrypt(String name, ByteString plaintext) + *

  • encrypt(ResourceName name, ByteString plaintext) + *

  • encrypt(String name, ByteString plaintext) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • encryptCallable() + *

  • encryptCallable() *

*
Decrypt

Decrypt

Decrypts data that was protected by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. The [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] must be [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • decrypt(DecryptRequest request) + *

  • decrypt(DecryptRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • decrypt(CryptoKeyName name, ByteString ciphertext) - *
  • decrypt(String name, ByteString ciphertext) + *

  • decrypt(CryptoKeyName name, ByteString ciphertext) + *

  • decrypt(String name, ByteString ciphertext) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • decryptCallable() + *

  • decryptCallable() *

*
AsymmetricSign

AsymmetricSign

Signs data using a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • asymmetricSign(AsymmetricSignRequest request) + *

  • asymmetricSign(AsymmetricSignRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • asymmetricSign(CryptoKeyVersionName name, Digest digest) - *
  • asymmetricSign(String name, Digest digest) + *

  • asymmetricSign(CryptoKeyVersionName name, Digest digest) + *

  • asymmetricSign(String name, Digest digest) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • asymmetricSignCallable() + *

  • asymmetricSignCallable() *

*
AsymmetricDecrypt

AsymmetricDecrypt

Decrypts data that was encrypted with a public key retrieved from [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey] corresponding to a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] with [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] ASYMMETRIC_DECRYPT.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • asymmetricDecrypt(AsymmetricDecryptRequest request) + *

  • asymmetricDecrypt(AsymmetricDecryptRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • asymmetricDecrypt(CryptoKeyVersionName name, ByteString ciphertext) - *
  • asymmetricDecrypt(String name, ByteString ciphertext) + *

  • asymmetricDecrypt(CryptoKeyVersionName name, ByteString ciphertext) + *

  • asymmetricDecrypt(String name, ByteString ciphertext) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • asymmetricDecryptCallable() + *

  • asymmetricDecryptCallable() *

*
UpdateCryptoKeyPrimaryVersion

UpdateCryptoKeyPrimaryVersion

Update the version of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that will be used in [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt]. *

Returns an error if called on an asymmetric key.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest request) + *

  • updateCryptoKeyPrimaryVersion(UpdateCryptoKeyPrimaryVersionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateCryptoKeyPrimaryVersion(CryptoKeyName name, String cryptoKeyVersionId) - *
  • updateCryptoKeyPrimaryVersion(String name, String cryptoKeyVersionId) + *

  • updateCryptoKeyPrimaryVersion(CryptoKeyName name, String cryptoKeyVersionId) + *

  • updateCryptoKeyPrimaryVersion(String name, String cryptoKeyVersionId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateCryptoKeyPrimaryVersionCallable() + *

  • updateCryptoKeyPrimaryVersionCallable() *

*
DestroyCryptoKeyVersion

DestroyCryptoKeyVersion

Schedule a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] for destruction. *

Upon calling this method, [CryptoKeyVersion.state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED] and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will be set to a time 24 hours in the future, at which point the [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be changed to [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED], and the key material will be irrevocably destroyed. *

Before the [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] is reached, [RestoreCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.RestoreCryptoKeyVersion] may be called to reverse the process.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • destroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest request) + *

  • destroyCryptoKeyVersion(DestroyCryptoKeyVersionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • destroyCryptoKeyVersion(CryptoKeyVersionName name) - *
  • destroyCryptoKeyVersion(String name) + *

  • destroyCryptoKeyVersion(CryptoKeyVersionName name) + *

  • destroyCryptoKeyVersion(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • destroyCryptoKeyVersionCallable() + *

  • destroyCryptoKeyVersionCallable() *

*
RestoreCryptoKeyVersion

RestoreCryptoKeyVersion

Restore a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in the [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED] state. *

Upon restoration of the CryptoKeyVersion, [state][google.cloud.kms.v1.CryptoKeyVersion.state] will be set to [DISABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DISABLED], and [destroy_time][google.cloud.kms.v1.CryptoKeyVersion.destroy_time] will be cleared.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • restoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest request) + *

  • restoreCryptoKeyVersion(RestoreCryptoKeyVersionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • restoreCryptoKeyVersion(CryptoKeyVersionName name) - *
  • restoreCryptoKeyVersion(String name) + *

  • restoreCryptoKeyVersion(CryptoKeyVersionName name) + *

  • restoreCryptoKeyVersion(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • restoreCryptoKeyVersionCallable() + *

  • restoreCryptoKeyVersionCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the access control policy for a resource. ADDED ONLY FOR MIXIN TESTS. Returns an empty policy if the resource exists and does not have a policy set.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
ListLocations

ListLocations

Lists information about the supported locations for this service.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listLocations(ListLocationsRequest request) + *

  • listLocations(ListLocationsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listLocationsPagedCallable() - *
  • listLocationsCallable() + *

  • listLocationsPagedCallable() + *

  • listLocationsCallable() *

*
GetLocation

GetLocation

Gets information about a location.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getLocation(GetLocationRequest request) + *

  • getLocation(GetLocationRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getLocationCallable() + *

  • getLocationCallable() *

*
TestIamPermissions

TestIamPermissions

This is a different comment for TestIamPermissions in the yaml file that should clobber the documentation in iam_policy.proto.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/library/src/com/google/cloud/example/library/v1/LibraryServiceClient.java b/test/integration/goldens/library/src/com/google/cloud/example/library/v1/LibraryServiceClient.java index 763aff11dd..792b325407 100644 --- a/test/integration/goldens/library/src/com/google/cloud/example/library/v1/LibraryServiceClient.java +++ b/test/integration/goldens/library/src/com/google/cloud/example/library/v1/LibraryServiceClient.java @@ -81,220 +81,221 @@ * as threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
CreateShelf

CreateShelf

Creates a shelf, and returns the new Shelf.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createShelf(CreateShelfRequest request) + *

  • createShelf(CreateShelfRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createShelf(Shelf shelf) + *

  • createShelf(Shelf shelf) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createShelfCallable() + *

  • createShelfCallable() *

*
GetShelf

GetShelf

Gets a shelf. Returns NOT_FOUND if the shelf does not exist.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getShelf(GetShelfRequest request) + *

  • getShelf(GetShelfRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getShelf(ShelfName name) - *
  • getShelf(String name) + *

  • getShelf(ShelfName name) + *

  • getShelf(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getShelfCallable() + *

  • getShelfCallable() *

*
ListShelves

ListShelves

Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listShelves(ListShelvesRequest request) + *

  • listShelves(ListShelvesRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listShelvesPagedCallable() - *
  • listShelvesCallable() + *

  • listShelvesPagedCallable() + *

  • listShelvesCallable() *

*
DeleteShelf

DeleteShelf

Deletes a shelf. Returns NOT_FOUND if the shelf does not exist.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteShelf(DeleteShelfRequest request) + *

  • deleteShelf(DeleteShelfRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteShelf(ShelfName name) - *
  • deleteShelf(String name) + *

  • deleteShelf(ShelfName name) + *

  • deleteShelf(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteShelfCallable() + *

  • deleteShelfCallable() *

*
MergeShelves

MergeShelves

Merges two shelves by adding all books from the shelf named `other_shelf_name` to shelf `name`, and deletes `other_shelf_name`. Returns the updated shelf. The book ids of the moved books may not be the same as the original books. *

Returns NOT_FOUND if either shelf does not exist. This call is a no-op if the specified shelves are the same.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • mergeShelves(MergeShelvesRequest request) + *

  • mergeShelves(MergeShelvesRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • mergeShelves(ShelfName name, ShelfName otherShelf) - *
  • mergeShelves(ShelfName name, String otherShelf) - *
  • mergeShelves(String name, ShelfName otherShelf) - *
  • mergeShelves(String name, String otherShelf) + *

  • mergeShelves(ShelfName name, ShelfName otherShelf) + *

  • mergeShelves(ShelfName name, String otherShelf) + *

  • mergeShelves(String name, ShelfName otherShelf) + *

  • mergeShelves(String name, String otherShelf) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • mergeShelvesCallable() + *

  • mergeShelvesCallable() *

*
CreateBook

CreateBook

Creates a book, and returns the new Book.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createBook(CreateBookRequest request) + *

  • createBook(CreateBookRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createBook(ShelfName parent, Book book) - *
  • createBook(String parent, Book book) + *

  • createBook(ShelfName parent, Book book) + *

  • createBook(String parent, Book book) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createBookCallable() + *

  • createBookCallable() *

*
GetBook

GetBook

Gets a book. Returns NOT_FOUND if the book does not exist.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getBook(GetBookRequest request) + *

  • getBook(GetBookRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getBook(BookName name) - *
  • getBook(String name) + *

  • getBook(BookName name) + *

  • getBook(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getBookCallable() + *

  • getBookCallable() *

*
ListBooks

ListBooks

Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listBooks(ListBooksRequest request) + *

  • listBooks(ListBooksRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listBooks(ShelfName parent) - *
  • listBooks(String parent) + *

  • listBooks(ShelfName parent) + *

  • listBooks(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listBooksPagedCallable() - *
  • listBooksCallable() + *

  • listBooksPagedCallable() + *

  • listBooksCallable() *

*
DeleteBook

DeleteBook

Deletes a book. Returns NOT_FOUND if the book does not exist.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteBook(DeleteBookRequest request) + *

  • deleteBook(DeleteBookRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteBook(BookName name) - *
  • deleteBook(String name) + *

  • deleteBook(BookName name) + *

  • deleteBook(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteBookCallable() + *

  • deleteBookCallable() *

*
UpdateBook

UpdateBook

Updates a book. Returns INVALID_ARGUMENT if the name of the book is non-empty and does not equal the existing name.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateBook(UpdateBookRequest request) + *

  • updateBook(UpdateBookRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateBook(Book book, FieldMask updateMask) + *

  • updateBook(Book book, FieldMask updateMask) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateBookCallable() + *

  • updateBookCallable() *

*
MoveBook

MoveBook

Moves a book to another shelf, and returns the new book. The book id of the new book may not be the same as the original book.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • moveBook(MoveBookRequest request) + *

  • moveBook(MoveBookRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • moveBook(BookName name, ShelfName otherShelfName) - *
  • moveBook(BookName name, String otherShelfName) - *
  • moveBook(String name, ShelfName otherShelfName) - *
  • moveBook(String name, String otherShelfName) + *

  • moveBook(BookName name, ShelfName otherShelfName) + *

  • moveBook(BookName name, String otherShelfName) + *

  • moveBook(String name, ShelfName otherShelfName) + *

  • moveBook(String name, String otherShelfName) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • moveBookCallable() + *

  • moveBookCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/logging/src/com/google/cloud/logging/v2/ConfigClient.java b/test/integration/goldens/logging/src/com/google/cloud/logging/v2/ConfigClient.java index 826ba5374a..ebd12a5156 100644 --- a/test/integration/goldens/logging/src/com/google/cloud/logging/v2/ConfigClient.java +++ b/test/integration/goldens/logging/src/com/google/cloud/logging/v2/ConfigClient.java @@ -115,63 +115,65 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
ListBuckets

ListBuckets

Lists log buckets.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listBuckets(ListBucketsRequest request) + *

  • listBuckets(ListBucketsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listBuckets(BillingAccountLocationName parent) - *
  • listBuckets(FolderLocationName parent) - *
  • listBuckets(LocationName parent) - *
  • listBuckets(OrganizationLocationName parent) - *
  • listBuckets(String parent) + *

  • listBuckets(BillingAccountLocationName parent) + *

  • listBuckets(FolderLocationName parent) + *

  • listBuckets(LocationName parent) + *

  • listBuckets(OrganizationLocationName parent) + *

  • listBuckets(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listBucketsPagedCallable() - *
  • listBucketsCallable() + *

  • listBucketsPagedCallable() + *

  • listBucketsCallable() *

*
GetBucket

GetBucket

Gets a log bucket.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getBucket(GetBucketRequest request) + *

  • getBucket(GetBucketRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getBucketCallable() + *

  • getBucketCallable() *

*
CreateBucket

CreateBucket

Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createBucket(CreateBucketRequest request) + *

  • createBucket(CreateBucketRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createBucketCallable() + *

  • createBucketCallable() *

*
UpdateBucket

UpdateBucket

Updates a log bucket. This method replaces the following fields in the existing bucket with values from the new bucket: `retention_period` *

If the retention period is decreased and the bucket is locked, `FAILED_PRECONDITION` will be returned. *

If the bucket has a `lifecycle_state` of `DELETE_REQUESTED`, then `FAILED_PRECONDITION` will be returned. @@ -179,343 +181,343 @@ *

*

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateBucket(UpdateBucketRequest request) + *

  • updateBucket(UpdateBucketRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateBucketCallable() + *

  • updateBucketCallable() *

*
DeleteBucket

DeleteBucket

Deletes a log bucket. *

Changes the bucket's `lifecycle_state` to the `DELETE_REQUESTED` state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteBucket(DeleteBucketRequest request) + *

  • deleteBucket(DeleteBucketRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteBucketCallable() + *

  • deleteBucketCallable() *

*
UndeleteBucket

UndeleteBucket

Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • undeleteBucket(UndeleteBucketRequest request) + *

  • undeleteBucket(UndeleteBucketRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • undeleteBucketCallable() + *

  • undeleteBucketCallable() *

*
ListViews

ListViews

Lists views on a log bucket.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listViews(ListViewsRequest request) + *

  • listViews(ListViewsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listViews(String parent) + *

  • listViews(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listViewsPagedCallable() - *
  • listViewsCallable() + *

  • listViewsPagedCallable() + *

  • listViewsCallable() *

*
GetView

GetView

Gets a view on a log bucket..

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getView(GetViewRequest request) + *

  • getView(GetViewRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getViewCallable() + *

  • getViewCallable() *

*
CreateView

CreateView

Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createView(CreateViewRequest request) + *

  • createView(CreateViewRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createViewCallable() + *

  • createViewCallable() *

*
UpdateView

UpdateView

Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: `filter`. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateView(UpdateViewRequest request) + *

  • updateView(UpdateViewRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateViewCallable() + *

  • updateViewCallable() *

*
DeleteView

DeleteView

Deletes a view on a log bucket. If an `UNAVAILABLE` error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteView(DeleteViewRequest request) + *

  • deleteView(DeleteViewRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteViewCallable() + *

  • deleteViewCallable() *

*
ListSinks

ListSinks

Lists sinks.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listSinks(ListSinksRequest request) + *

  • listSinks(ListSinksRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listSinks(BillingAccountName parent) - *
  • listSinks(FolderName parent) - *
  • listSinks(OrganizationName parent) - *
  • listSinks(ProjectName parent) - *
  • listSinks(String parent) + *

  • listSinks(BillingAccountName parent) + *

  • listSinks(FolderName parent) + *

  • listSinks(OrganizationName parent) + *

  • listSinks(ProjectName parent) + *

  • listSinks(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listSinksPagedCallable() - *
  • listSinksCallable() + *

  • listSinksPagedCallable() + *

  • listSinksCallable() *

*
GetSink

GetSink

Gets a sink.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getSink(GetSinkRequest request) + *

  • getSink(GetSinkRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getSink(LogSinkName sinkName) - *
  • getSink(String sinkName) + *

  • getSink(LogSinkName sinkName) + *

  • getSink(String sinkName) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getSinkCallable() + *

  • getSinkCallable() *

*
CreateSink

CreateSink

Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createSink(CreateSinkRequest request) + *

  • createSink(CreateSinkRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createSink(BillingAccountName parent, LogSink sink) - *
  • createSink(FolderName parent, LogSink sink) - *
  • createSink(OrganizationName parent, LogSink sink) - *
  • createSink(ProjectName parent, LogSink sink) - *
  • createSink(String parent, LogSink sink) + *

  • createSink(BillingAccountName parent, LogSink sink) + *

  • createSink(FolderName parent, LogSink sink) + *

  • createSink(OrganizationName parent, LogSink sink) + *

  • createSink(ProjectName parent, LogSink sink) + *

  • createSink(String parent, LogSink sink) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createSinkCallable() + *

  • createSinkCallable() *

*
UpdateSink

UpdateSink

Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: `destination`, and `filter`. *

The updated sink might also have a new `writer_identity`; see the `unique_writer_identity` field.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateSink(UpdateSinkRequest request) + *

  • updateSink(UpdateSinkRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateSink(LogSinkName sinkName, LogSink sink) - *
  • updateSink(String sinkName, LogSink sink) - *
  • updateSink(LogSinkName sinkName, LogSink sink, FieldMask updateMask) - *
  • updateSink(String sinkName, LogSink sink, FieldMask updateMask) + *

  • updateSink(LogSinkName sinkName, LogSink sink) + *

  • updateSink(String sinkName, LogSink sink) + *

  • updateSink(LogSinkName sinkName, LogSink sink, FieldMask updateMask) + *

  • updateSink(String sinkName, LogSink sink, FieldMask updateMask) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateSinkCallable() + *

  • updateSinkCallable() *

*
DeleteSink

DeleteSink

Deletes a sink. If the sink has a unique `writer_identity`, then that service account is also deleted.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteSink(DeleteSinkRequest request) + *

  • deleteSink(DeleteSinkRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteSink(LogSinkName sinkName) - *
  • deleteSink(String sinkName) + *

  • deleteSink(LogSinkName sinkName) + *

  • deleteSink(String sinkName) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteSinkCallable() + *

  • deleteSinkCallable() *

*
ListExclusions

ListExclusions

Lists all the exclusions on the _Default sink in a parent resource.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listExclusions(ListExclusionsRequest request) + *

  • listExclusions(ListExclusionsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listExclusions(BillingAccountName parent) - *
  • listExclusions(FolderName parent) - *
  • listExclusions(OrganizationName parent) - *
  • listExclusions(ProjectName parent) - *
  • listExclusions(String parent) + *

  • listExclusions(BillingAccountName parent) + *

  • listExclusions(FolderName parent) + *

  • listExclusions(OrganizationName parent) + *

  • listExclusions(ProjectName parent) + *

  • listExclusions(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listExclusionsPagedCallable() - *
  • listExclusionsCallable() + *

  • listExclusionsPagedCallable() + *

  • listExclusionsCallable() *

*
GetExclusion

GetExclusion

Gets the description of an exclusion in the _Default sink.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getExclusion(GetExclusionRequest request) + *

  • getExclusion(GetExclusionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getExclusion(LogExclusionName name) - *
  • getExclusion(String name) + *

  • getExclusion(LogExclusionName name) + *

  • getExclusion(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getExclusionCallable() + *

  • getExclusionCallable() *

*
CreateExclusion

CreateExclusion

Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createExclusion(CreateExclusionRequest request) + *

  • createExclusion(CreateExclusionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createExclusion(BillingAccountName parent, LogExclusion exclusion) - *
  • createExclusion(FolderName parent, LogExclusion exclusion) - *
  • createExclusion(OrganizationName parent, LogExclusion exclusion) - *
  • createExclusion(ProjectName parent, LogExclusion exclusion) - *
  • createExclusion(String parent, LogExclusion exclusion) + *

  • createExclusion(BillingAccountName parent, LogExclusion exclusion) + *

  • createExclusion(FolderName parent, LogExclusion exclusion) + *

  • createExclusion(OrganizationName parent, LogExclusion exclusion) + *

  • createExclusion(ProjectName parent, LogExclusion exclusion) + *

  • createExclusion(String parent, LogExclusion exclusion) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createExclusionCallable() + *

  • createExclusionCallable() *

*
UpdateExclusion

UpdateExclusion

Changes one or more properties of an existing exclusion in the _Default sink.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateExclusion(UpdateExclusionRequest request) + *

  • updateExclusion(UpdateExclusionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateExclusion(LogExclusionName name, LogExclusion exclusion, FieldMask updateMask) - *
  • updateExclusion(String name, LogExclusion exclusion, FieldMask updateMask) + *

  • updateExclusion(LogExclusionName name, LogExclusion exclusion, FieldMask updateMask) + *

  • updateExclusion(String name, LogExclusion exclusion, FieldMask updateMask) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateExclusionCallable() + *

  • updateExclusionCallable() *

*
DeleteExclusion

DeleteExclusion

Deletes an exclusion in the _Default sink.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteExclusion(DeleteExclusionRequest request) + *

  • deleteExclusion(DeleteExclusionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteExclusion(LogExclusionName name) - *
  • deleteExclusion(String name) + *

  • deleteExclusion(LogExclusionName name) + *

  • deleteExclusion(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteExclusionCallable() + *

  • deleteExclusionCallable() *

*
GetCmekSettings

GetCmekSettings

Gets the Logging CMEK settings for the given resource. *

Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. *

See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getCmekSettings(GetCmekSettingsRequest request) + *

  • getCmekSettings(GetCmekSettingsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getCmekSettingsCallable() + *

  • getCmekSettingsCallable() *

*
UpdateCmekSettings

UpdateCmekSettings

Updates the Log Router CMEK settings for the given resource. *

Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization. *

[UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings] will fail if 1) `kms_key_name` is invalid, or 2) the associated service account does not have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or 3) access to the key is disabled. @@ -523,37 +525,37 @@ *

*

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateCmekSettings(UpdateCmekSettingsRequest request) + *

  • updateCmekSettings(UpdateCmekSettingsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateCmekSettingsCallable() + *

  • updateCmekSettingsCallable() *

*
GetSettings

GetSettings

Gets the Log Router settings for the given resource. *

Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. *

See [Enabling CMEK for Log Router](https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getSettings(GetSettingsRequest request) + *

  • getSettings(GetSettingsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getSettings(SettingsName name) - *
  • getSettings(String name) + *

  • getSettings(SettingsName name) + *

  • getSettings(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getSettingsCallable() + *

  • getSettingsCallable() *

*
UpdateSettings

UpdateSettings

Updates the Log Router settings for the given resource. *

Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization. *

[UpdateSettings][google.logging.v2.ConfigServiceV2.UpdateSettings] will fail if 1) `kms_key_name` is invalid, or 2) the associated service account does not have the required `roles/cloudkms.cryptoKeyEncrypterDecrypter` role assigned for the key, or 3) access to the key is disabled. 4) `location_id` is not supported by Logging. 5) `location_id` violate OrgPolicy. @@ -561,34 +563,33 @@ *

*

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateSettings(UpdateSettingsRequest request) + *

  • updateSettings(UpdateSettingsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateSettings(Settings settings, FieldMask updateMask) + *

  • updateSettings(Settings settings, FieldMask updateMask) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateSettingsCallable() + *

  • updateSettingsCallable() *

*
CopyLogEntries

CopyLogEntries

Copies a set of log entries from a log bucket to a Cloud Storage bucket.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • copyLogEntriesAsync(CopyLogEntriesRequest request) + *

  • copyLogEntriesAsync(CopyLogEntriesRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • copyLogEntriesOperationCallable() - *
  • copyLogEntriesCallable() + *

  • copyLogEntriesOperationCallable() + *

  • copyLogEntriesCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/logging/src/com/google/cloud/logging/v2/LoggingClient.java b/test/integration/goldens/logging/src/com/google/cloud/logging/v2/LoggingClient.java index 056ca3dca4..2206fbd2ac 100644 --- a/test/integration/goldens/logging/src/com/google/cloud/logging/v2/LoggingClient.java +++ b/test/integration/goldens/logging/src/com/google/cloud/logging/v2/LoggingClient.java @@ -77,116 +77,117 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
DeleteLog

DeleteLog

Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteLog(DeleteLogRequest request) + *

  • deleteLog(DeleteLogRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteLog(LogName logName) - *
  • deleteLog(String logName) + *

  • deleteLog(LogName logName) + *

  • deleteLog(String logName) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteLogCallable() + *

  • deleteLogCallable() *

*
WriteLogEntries

WriteLogEntries

Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • writeLogEntries(WriteLogEntriesRequest request) + *

  • writeLogEntries(WriteLogEntriesRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • writeLogEntries(LogName logName, MonitoredResource resource, Map labels, List entries) - *
  • writeLogEntries(String logName, MonitoredResource resource, Map labels, List entries) + *

  • writeLogEntries(LogName logName, MonitoredResource resource, Map<String, String> labels, List<LogEntry> entries) + *

  • writeLogEntries(String logName, MonitoredResource resource, Map<String, String> labels, List<LogEntry> entries) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • writeLogEntriesCallable() + *

  • writeLogEntriesCallable() *

*
ListLogEntries

ListLogEntries

Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see [Exporting Logs](https://cloud.google.com/logging/docs/export).

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listLogEntries(ListLogEntriesRequest request) + *

  • listLogEntries(ListLogEntriesRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listLogEntries(List resourceNames, String filter, String orderBy) + *

  • listLogEntries(List<String> resourceNames, String filter, String orderBy) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listLogEntriesPagedCallable() - *
  • listLogEntriesCallable() + *

  • listLogEntriesPagedCallable() + *

  • listLogEntriesCallable() *

*
ListMonitoredResourceDescriptors

ListMonitoredResourceDescriptors

Lists the descriptors for monitored resource types used by Logging.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest request) + *

  • listMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listMonitoredResourceDescriptorsPagedCallable() - *
  • listMonitoredResourceDescriptorsCallable() + *

  • listMonitoredResourceDescriptorsPagedCallable() + *

  • listMonitoredResourceDescriptorsCallable() *

*
ListLogs

ListLogs

Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listLogs(ListLogsRequest request) + *

  • listLogs(ListLogsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listLogs(BillingAccountName parent) - *
  • listLogs(FolderName parent) - *
  • listLogs(OrganizationName parent) - *
  • listLogs(ProjectName parent) - *
  • listLogs(String parent) + *

  • listLogs(BillingAccountName parent) + *

  • listLogs(FolderName parent) + *

  • listLogs(OrganizationName parent) + *

  • listLogs(ProjectName parent) + *

  • listLogs(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listLogsPagedCallable() - *
  • listLogsCallable() + *

  • listLogsPagedCallable() + *

  • listLogsCallable() *

*
TailLogEntries

TailLogEntries

Streaming read of log entries as they are ingested. Until the stream is terminated, it will continue reading logs.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • tailLogEntriesCallable() + *

  • tailLogEntriesCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/logging/src/com/google/cloud/logging/v2/MetricsClient.java b/test/integration/goldens/logging/src/com/google/cloud/logging/v2/MetricsClient.java index 86971db386..c5e4ffe2e3 100644 --- a/test/integration/goldens/logging/src/com/google/cloud/logging/v2/MetricsClient.java +++ b/test/integration/goldens/logging/src/com/google/cloud/logging/v2/MetricsClient.java @@ -65,107 +65,108 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
ListLogMetrics

ListLogMetrics

Lists logs-based metrics.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listLogMetrics(ListLogMetricsRequest request) + *

  • listLogMetrics(ListLogMetricsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listLogMetrics(ProjectName parent) - *
  • listLogMetrics(String parent) + *

  • listLogMetrics(ProjectName parent) + *

  • listLogMetrics(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listLogMetricsPagedCallable() - *
  • listLogMetricsCallable() + *

  • listLogMetricsPagedCallable() + *

  • listLogMetricsCallable() *

*
GetLogMetric

GetLogMetric

Gets a logs-based metric.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getLogMetric(GetLogMetricRequest request) + *

  • getLogMetric(GetLogMetricRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getLogMetric(LogMetricName metricName) - *
  • getLogMetric(String metricName) + *

  • getLogMetric(LogMetricName metricName) + *

  • getLogMetric(String metricName) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getLogMetricCallable() + *

  • getLogMetricCallable() *

*
CreateLogMetric

CreateLogMetric

Creates a logs-based metric.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createLogMetric(CreateLogMetricRequest request) + *

  • createLogMetric(CreateLogMetricRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createLogMetric(ProjectName parent, LogMetric metric) - *
  • createLogMetric(String parent, LogMetric metric) + *

  • createLogMetric(ProjectName parent, LogMetric metric) + *

  • createLogMetric(String parent, LogMetric metric) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createLogMetricCallable() + *

  • createLogMetricCallable() *

*
UpdateLogMetric

UpdateLogMetric

Creates or updates a logs-based metric.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateLogMetric(UpdateLogMetricRequest request) + *

  • updateLogMetric(UpdateLogMetricRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateLogMetric(LogMetricName metricName, LogMetric metric) - *
  • updateLogMetric(String metricName, LogMetric metric) + *

  • updateLogMetric(LogMetricName metricName, LogMetric metric) + *

  • updateLogMetric(String metricName, LogMetric metric) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateLogMetricCallable() + *

  • updateLogMetricCallable() *

*
DeleteLogMetric

DeleteLogMetric

Deletes a logs-based metric.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteLogMetric(DeleteLogMetricRequest request) + *

  • deleteLogMetric(DeleteLogMetricRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteLogMetric(LogMetricName metricName) - *
  • deleteLogMetric(String metricName) + *

  • deleteLogMetric(LogMetricName metricName) + *

  • deleteLogMetric(String metricName) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteLogMetricCallable() + *

  • deleteLogMetricCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/SchemaServiceClient.java b/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/SchemaServiceClient.java index fe98951130..d8b3c6f84c 100644 --- a/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/SchemaServiceClient.java +++ b/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/SchemaServiceClient.java @@ -80,242 +80,243 @@ * as threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
CreateSchema

CreateSchema

Creates a schema.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createSchema(CreateSchemaRequest request) + *

  • createSchema(CreateSchemaRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createSchema(ProjectName parent, Schema schema, String schemaId) - *
  • createSchema(String parent, Schema schema, String schemaId) + *

  • createSchema(ProjectName parent, Schema schema, String schemaId) + *

  • createSchema(String parent, Schema schema, String schemaId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createSchemaCallable() + *

  • createSchemaCallable() *

*
GetSchema

GetSchema

Gets a schema.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getSchema(GetSchemaRequest request) + *

  • getSchema(GetSchemaRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getSchema(SchemaName name) - *
  • getSchema(String name) + *

  • getSchema(SchemaName name) + *

  • getSchema(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getSchemaCallable() + *

  • getSchemaCallable() *

*
ListSchemas

ListSchemas

Lists schemas in a project.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listSchemas(ListSchemasRequest request) + *

  • listSchemas(ListSchemasRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listSchemas(ProjectName parent) - *
  • listSchemas(String parent) + *

  • listSchemas(ProjectName parent) + *

  • listSchemas(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listSchemasPagedCallable() - *
  • listSchemasCallable() + *

  • listSchemasPagedCallable() + *

  • listSchemasCallable() *

*
ListSchemaRevisions

ListSchemaRevisions

Lists all schema revisions for the named schema.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listSchemaRevisions(ListSchemaRevisionsRequest request) + *

  • listSchemaRevisions(ListSchemaRevisionsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listSchemaRevisions(SchemaName name) - *
  • listSchemaRevisions(String name) + *

  • listSchemaRevisions(SchemaName name) + *

  • listSchemaRevisions(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listSchemaRevisionsPagedCallable() - *
  • listSchemaRevisionsCallable() + *

  • listSchemaRevisionsPagedCallable() + *

  • listSchemaRevisionsCallable() *

*
CommitSchema

CommitSchema

Commits a new schema revision to an existing schema.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • commitSchema(CommitSchemaRequest request) + *

  • commitSchema(CommitSchemaRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • commitSchema(SchemaName name, Schema schema) - *
  • commitSchema(String name, Schema schema) + *

  • commitSchema(SchemaName name, Schema schema) + *

  • commitSchema(String name, Schema schema) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • commitSchemaCallable() + *

  • commitSchemaCallable() *

*
RollbackSchema

RollbackSchema

Creates a new schema revision that is a copy of the provided revision_id.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • rollbackSchema(RollbackSchemaRequest request) + *

  • rollbackSchema(RollbackSchemaRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • rollbackSchema(SchemaName name, String revisionId) - *
  • rollbackSchema(String name, String revisionId) + *

  • rollbackSchema(SchemaName name, String revisionId) + *

  • rollbackSchema(String name, String revisionId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • rollbackSchemaCallable() + *

  • rollbackSchemaCallable() *

*
DeleteSchemaRevision

DeleteSchemaRevision

Deletes a specific schema revision.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteSchemaRevision(DeleteSchemaRevisionRequest request) + *

  • deleteSchemaRevision(DeleteSchemaRevisionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteSchemaRevision(SchemaName name, String revisionId) - *
  • deleteSchemaRevision(String name, String revisionId) + *

  • deleteSchemaRevision(SchemaName name, String revisionId) + *

  • deleteSchemaRevision(String name, String revisionId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteSchemaRevisionCallable() + *

  • deleteSchemaRevisionCallable() *

*
DeleteSchema

DeleteSchema

Deletes a schema.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteSchema(DeleteSchemaRequest request) + *

  • deleteSchema(DeleteSchemaRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteSchema(SchemaName name) - *
  • deleteSchema(String name) + *

  • deleteSchema(SchemaName name) + *

  • deleteSchema(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteSchemaCallable() + *

  • deleteSchemaCallable() *

*
ValidateSchema

ValidateSchema

Validates a schema.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • validateSchema(ValidateSchemaRequest request) + *

  • validateSchema(ValidateSchemaRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • validateSchema(ProjectName parent, Schema schema) - *
  • validateSchema(String parent, Schema schema) + *

  • validateSchema(ProjectName parent, Schema schema) + *

  • validateSchema(String parent, Schema schema) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • validateSchemaCallable() + *

  • validateSchemaCallable() *

*
ValidateMessage

ValidateMessage

Validates a message against a schema.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • validateMessage(ValidateMessageRequest request) + *

  • validateMessage(ValidateMessageRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • validateMessageCallable() + *

  • validateMessageCallable() *

*
SetIamPolicy

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • setIamPolicy(SetIamPolicyRequest request) + *

  • setIamPolicy(SetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • setIamPolicyCallable() + *

  • setIamPolicyCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
TestIamPermissions

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/SubscriptionAdminClient.java b/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/SubscriptionAdminClient.java index 227d9b1388..f454b15c6c 100644 --- a/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/SubscriptionAdminClient.java +++ b/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/SubscriptionAdminClient.java @@ -96,346 +96,347 @@ * close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
CreateSubscription

CreateSubscription

Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. *

If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createSubscription(Subscription request) + *

  • createSubscription(Subscription request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createSubscription(SubscriptionName name, TopicName topic, PushConfig pushConfig, int ackDeadlineSeconds) - *
  • createSubscription(SubscriptionName name, String topic, PushConfig pushConfig, int ackDeadlineSeconds) - *
  • createSubscription(String name, TopicName topic, PushConfig pushConfig, int ackDeadlineSeconds) - *
  • createSubscription(String name, String topic, PushConfig pushConfig, int ackDeadlineSeconds) + *

  • createSubscription(SubscriptionName name, TopicName topic, PushConfig pushConfig, int ackDeadlineSeconds) + *

  • createSubscription(SubscriptionName name, String topic, PushConfig pushConfig, int ackDeadlineSeconds) + *

  • createSubscription(String name, TopicName topic, PushConfig pushConfig, int ackDeadlineSeconds) + *

  • createSubscription(String name, String topic, PushConfig pushConfig, int ackDeadlineSeconds) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createSubscriptionCallable() + *

  • createSubscriptionCallable() *

*
GetSubscription

GetSubscription

Gets the configuration details of a subscription.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getSubscription(GetSubscriptionRequest request) + *

  • getSubscription(GetSubscriptionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getSubscription(SubscriptionName subscription) - *
  • getSubscription(String subscription) + *

  • getSubscription(SubscriptionName subscription) + *

  • getSubscription(String subscription) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getSubscriptionCallable() + *

  • getSubscriptionCallable() *

*
UpdateSubscription

UpdateSubscription

Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateSubscription(UpdateSubscriptionRequest request) + *

  • updateSubscription(UpdateSubscriptionRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateSubscriptionCallable() + *

  • updateSubscriptionCallable() *

*
ListSubscriptions

ListSubscriptions

Lists matching subscriptions.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listSubscriptions(ListSubscriptionsRequest request) + *

  • listSubscriptions(ListSubscriptionsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listSubscriptions(ProjectName project) - *
  • listSubscriptions(String project) + *

  • listSubscriptions(ProjectName project) + *

  • listSubscriptions(String project) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listSubscriptionsPagedCallable() - *
  • listSubscriptionsCallable() + *

  • listSubscriptionsPagedCallable() + *

  • listSubscriptionsCallable() *

*
DeleteSubscription

DeleteSubscription

Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteSubscription(DeleteSubscriptionRequest request) + *

  • deleteSubscription(DeleteSubscriptionRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteSubscription(SubscriptionName subscription) - *
  • deleteSubscription(String subscription) + *

  • deleteSubscription(SubscriptionName subscription) + *

  • deleteSubscription(String subscription) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteSubscriptionCallable() + *

  • deleteSubscriptionCallable() *

*
ModifyAckDeadline

ModifyAckDeadline

Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • modifyAckDeadline(ModifyAckDeadlineRequest request) + *

  • modifyAckDeadline(ModifyAckDeadlineRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • modifyAckDeadline(SubscriptionName subscription, List ackIds, int ackDeadlineSeconds) - *
  • modifyAckDeadline(String subscription, List ackIds, int ackDeadlineSeconds) + *

  • modifyAckDeadline(SubscriptionName subscription, List<String> ackIds, int ackDeadlineSeconds) + *

  • modifyAckDeadline(String subscription, List<String> ackIds, int ackDeadlineSeconds) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • modifyAckDeadlineCallable() + *

  • modifyAckDeadlineCallable() *

*
Acknowledge

Acknowledge

Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. *

Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • acknowledge(AcknowledgeRequest request) + *

  • acknowledge(AcknowledgeRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • acknowledge(SubscriptionName subscription, List ackIds) - *
  • acknowledge(String subscription, List ackIds) + *

  • acknowledge(SubscriptionName subscription, List<String> ackIds) + *

  • acknowledge(String subscription, List<String> ackIds) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • acknowledgeCallable() + *

  • acknowledgeCallable() *

*
Pull

Pull

Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • pull(PullRequest request) + *

  • pull(PullRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • pull(SubscriptionName subscription, int maxMessages) - *
  • pull(String subscription, int maxMessages) - *
  • pull(SubscriptionName subscription, boolean returnImmediately, int maxMessages) - *
  • pull(String subscription, boolean returnImmediately, int maxMessages) + *

  • pull(SubscriptionName subscription, int maxMessages) + *

  • pull(String subscription, int maxMessages) + *

  • pull(SubscriptionName subscription, boolean returnImmediately, int maxMessages) + *

  • pull(String subscription, boolean returnImmediately, int maxMessages) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • pullCallable() + *

  • pullCallable() *

*
StreamingPull

StreamingPull

Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgements and ack deadline modifications back to the server. The server will close the stream and return the status on any error. The server may close the stream with status `UNAVAILABLE` to reassign server-side resources, in which case, the client should re-establish the stream. Flow control can be achieved by configuring the underlying RPC channel.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • streamingPullCallable() + *

  • streamingPullCallable() *

*
ModifyPushConfig

ModifyPushConfig

Modifies the `PushConfig` for a specified subscription. *

This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • modifyPushConfig(ModifyPushConfigRequest request) + *

  • modifyPushConfig(ModifyPushConfigRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • modifyPushConfig(SubscriptionName subscription, PushConfig pushConfig) - *
  • modifyPushConfig(String subscription, PushConfig pushConfig) + *

  • modifyPushConfig(SubscriptionName subscription, PushConfig pushConfig) + *

  • modifyPushConfig(String subscription, PushConfig pushConfig) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • modifyPushConfigCallable() + *

  • modifyPushConfigCallable() *

*
GetSnapshot

GetSnapshot

Gets the configuration details of a snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getSnapshot(GetSnapshotRequest request) + *

  • getSnapshot(GetSnapshotRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getSnapshot(SnapshotName snapshot) - *
  • getSnapshot(String snapshot) + *

  • getSnapshot(SnapshotName snapshot) + *

  • getSnapshot(String snapshot) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getSnapshotCallable() + *

  • getSnapshotCallable() *

*
ListSnapshots

ListSnapshots

Lists the existing snapshots. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listSnapshots(ListSnapshotsRequest request) + *

  • listSnapshots(ListSnapshotsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listSnapshots(ProjectName project) - *
  • listSnapshots(String project) + *

  • listSnapshots(ProjectName project) + *

  • listSnapshots(String project) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listSnapshotsPagedCallable() - *
  • listSnapshotsCallable() + *

  • listSnapshotsPagedCallable() + *

  • listSnapshotsCallable() *

*
CreateSnapshot

CreateSnapshot

Creates a snapshot from the requested subscription. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createSnapshot(CreateSnapshotRequest request) + *

  • createSnapshot(CreateSnapshotRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createSnapshot(SnapshotName name, SubscriptionName subscription) - *
  • createSnapshot(SnapshotName name, String subscription) - *
  • createSnapshot(String name, SubscriptionName subscription) - *
  • createSnapshot(String name, String subscription) + *

  • createSnapshot(SnapshotName name, SubscriptionName subscription) + *

  • createSnapshot(SnapshotName name, String subscription) + *

  • createSnapshot(String name, SubscriptionName subscription) + *

  • createSnapshot(String name, String subscription) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createSnapshotCallable() + *

  • createSnapshotCallable() *

*
UpdateSnapshot

UpdateSnapshot

Updates an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateSnapshot(UpdateSnapshotRequest request) + *

  • updateSnapshot(UpdateSnapshotRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateSnapshotCallable() + *

  • updateSnapshotCallable() *

*
DeleteSnapshot

DeleteSnapshot

Removes an existing snapshot. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteSnapshot(DeleteSnapshotRequest request) + *

  • deleteSnapshot(DeleteSnapshotRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteSnapshot(SnapshotName snapshot) - *
  • deleteSnapshot(String snapshot) + *

  • deleteSnapshot(SnapshotName snapshot) + *

  • deleteSnapshot(String snapshot) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteSnapshotCallable() + *

  • deleteSnapshotCallable() *

*
Seek

Seek

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • seek(SeekRequest request) + *

  • seek(SeekRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • seekCallable() + *

  • seekCallable() *

*
SetIamPolicy

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • setIamPolicy(SetIamPolicyRequest request) + *

  • setIamPolicy(SetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • setIamPolicyCallable() + *

  • setIamPolicyCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
TestIamPermissions

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/TopicAdminClient.java b/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/TopicAdminClient.java index c0181bc2db..28234b2ce8 100644 --- a/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/TopicAdminClient.java +++ b/test/integration/goldens/pubsub/src/com/google/cloud/pubsub/v1/TopicAdminClient.java @@ -79,219 +79,220 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
CreateTopic

CreateTopic

Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names).

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createTopic(Topic request) + *

  • createTopic(Topic request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createTopic(TopicName name) - *
  • createTopic(String name) + *

  • createTopic(TopicName name) + *

  • createTopic(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createTopicCallable() + *

  • createTopicCallable() *

*
UpdateTopic

UpdateTopic

Updates an existing topic. Note that certain properties of a topic are not modifiable.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateTopic(UpdateTopicRequest request) + *

  • updateTopic(UpdateTopicRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateTopicCallable() + *

  • updateTopicCallable() *

*
Publish

Publish

Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • publish(PublishRequest request) + *

  • publish(PublishRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • publish(TopicName topic, List messages) - *
  • publish(String topic, List messages) + *

  • publish(TopicName topic, List<PubsubMessage> messages) + *

  • publish(String topic, List<PubsubMessage> messages) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • publishCallable() + *

  • publishCallable() *

*
GetTopic

GetTopic

Gets the configuration of a topic.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getTopic(GetTopicRequest request) + *

  • getTopic(GetTopicRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getTopic(TopicName topic) - *
  • getTopic(String topic) + *

  • getTopic(TopicName topic) + *

  • getTopic(String topic) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getTopicCallable() + *

  • getTopicCallable() *

*
ListTopics

ListTopics

Lists matching topics.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listTopics(ListTopicsRequest request) + *

  • listTopics(ListTopicsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listTopics(ProjectName project) - *
  • listTopics(String project) + *

  • listTopics(ProjectName project) + *

  • listTopics(String project) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listTopicsPagedCallable() - *
  • listTopicsCallable() + *

  • listTopicsPagedCallable() + *

  • listTopicsCallable() *

*
ListTopicSubscriptions

ListTopicSubscriptions

Lists the names of the attached subscriptions on this topic.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listTopicSubscriptions(ListTopicSubscriptionsRequest request) + *

  • listTopicSubscriptions(ListTopicSubscriptionsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listTopicSubscriptions(TopicName topic) - *
  • listTopicSubscriptions(String topic) + *

  • listTopicSubscriptions(TopicName topic) + *

  • listTopicSubscriptions(String topic) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listTopicSubscriptionsPagedCallable() - *
  • listTopicSubscriptionsCallable() + *

  • listTopicSubscriptionsPagedCallable() + *

  • listTopicSubscriptionsCallable() *

*
ListTopicSnapshots

ListTopicSnapshots

Lists the names of the snapshots on this topic. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listTopicSnapshots(ListTopicSnapshotsRequest request) + *

  • listTopicSnapshots(ListTopicSnapshotsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listTopicSnapshots(TopicName topic) - *
  • listTopicSnapshots(String topic) + *

  • listTopicSnapshots(TopicName topic) + *

  • listTopicSnapshots(String topic) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listTopicSnapshotsPagedCallable() - *
  • listTopicSnapshotsCallable() + *

  • listTopicSnapshotsPagedCallable() + *

  • listTopicSnapshotsCallable() *

*
DeleteTopic

DeleteTopic

Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteTopic(DeleteTopicRequest request) + *

  • deleteTopic(DeleteTopicRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteTopic(TopicName topic) - *
  • deleteTopic(String topic) + *

  • deleteTopic(TopicName topic) + *

  • deleteTopic(String topic) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteTopicCallable() + *

  • deleteTopicCallable() *

*
DetachSubscription

DetachSubscription

Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • detachSubscription(DetachSubscriptionRequest request) + *

  • detachSubscription(DetachSubscriptionRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • detachSubscriptionCallable() + *

  • detachSubscriptionCallable() *

*
SetIamPolicy

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy. *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • setIamPolicy(SetIamPolicyRequest request) + *

  • setIamPolicy(SetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • setIamPolicyCallable() + *

  • setIamPolicyCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
TestIamPermissions

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. *

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/redis/src/com/google/cloud/redis/v1beta1/CloudRedisClient.java b/test/integration/goldens/redis/src/com/google/cloud/redis/v1beta1/CloudRedisClient.java index 1edf9f3129..867d149642 100644 --- a/test/integration/goldens/redis/src/com/google/cloud/redis/v1beta1/CloudRedisClient.java +++ b/test/integration/goldens/redis/src/com/google/cloud/redis/v1beta1/CloudRedisClient.java @@ -83,12 +83,14 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
ListInstances

ListInstances

Lists all Redis instances owned by a project in either the specified location (region) or all locations. *

The location should have the following format: *

    @@ -98,60 +100,60 @@ *
*

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listInstances(ListInstancesRequest request) + *

  • listInstances(ListInstancesRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listInstances(LocationName parent) - *
  • listInstances(String parent) + *

  • listInstances(LocationName parent) + *

  • listInstances(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listInstancesPagedCallable() - *
  • listInstancesCallable() + *

  • listInstancesPagedCallable() + *

  • listInstancesCallable() *

*
GetInstance

GetInstance

Gets the details of a specific Redis instance.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getInstance(GetInstanceRequest request) + *

  • getInstance(GetInstanceRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getInstance(InstanceName name) - *
  • getInstance(String name) + *

  • getInstance(InstanceName name) + *

  • getInstance(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getInstanceCallable() + *

  • getInstanceCallable() *

*
GetInstanceAuthString

GetInstanceAuthString

Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getInstanceAuthString(GetInstanceAuthStringRequest request) + *

  • getInstanceAuthString(GetInstanceAuthStringRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getInstanceAuthString(InstanceName name) - *
  • getInstanceAuthString(String name) + *

  • getInstanceAuthString(InstanceName name) + *

  • getInstanceAuthString(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getInstanceAuthStringCallable() + *

  • getInstanceAuthStringCallable() *

*
CreateInstance

CreateInstance

Creates a Redis instance based on the specified tier and memory size. *

By default, the instance is accessible from the project's [default network](https://cloud.google.com/vpc/docs/vpc). *

The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. The completed longrunning.Operation will contain the new instance object in the response field. @@ -159,163 +161,162 @@ *

*

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createInstanceAsync(CreateInstanceRequest request) + *

  • createInstanceAsync(CreateInstanceRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • createInstanceAsync(LocationName parent, String instanceId, Instance instance) - *
  • createInstanceAsync(String parent, String instanceId, Instance instance) + *

  • createInstanceAsync(LocationName parent, String instanceId, Instance instance) + *

  • createInstanceAsync(String parent, String instanceId, Instance instance) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createInstanceOperationCallable() - *
  • createInstanceCallable() + *

  • createInstanceOperationCallable() + *

  • createInstanceCallable() *

*
UpdateInstance

UpdateInstance

Updates the metadata and configuration of a specific Redis instance. *

Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateInstanceAsync(UpdateInstanceRequest request) + *

  • updateInstanceAsync(UpdateInstanceRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • updateInstanceAsync(FieldMask updateMask, Instance instance) + *

  • updateInstanceAsync(FieldMask updateMask, Instance instance) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateInstanceOperationCallable() - *
  • updateInstanceCallable() + *

  • updateInstanceOperationCallable() + *

  • updateInstanceCallable() *

*
UpgradeInstance

UpgradeInstance

Upgrades Redis instance to the newer Redis version specified in the request.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • upgradeInstanceAsync(UpgradeInstanceRequest request) + *

  • upgradeInstanceAsync(UpgradeInstanceRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • upgradeInstanceAsync(InstanceName name, String redisVersion) - *
  • upgradeInstanceAsync(String name, String redisVersion) + *

  • upgradeInstanceAsync(InstanceName name, String redisVersion) + *

  • upgradeInstanceAsync(String name, String redisVersion) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • upgradeInstanceOperationCallable() - *
  • upgradeInstanceCallable() + *

  • upgradeInstanceOperationCallable() + *

  • upgradeInstanceCallable() *

*
ImportInstance

ImportInstance

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. *

Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. *

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • importInstanceAsync(ImportInstanceRequest request) + *

  • importInstanceAsync(ImportInstanceRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • importInstanceAsync(String name, InputConfig inputConfig) + *

  • importInstanceAsync(String name, InputConfig inputConfig) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • importInstanceOperationCallable() - *
  • importInstanceCallable() + *

  • importInstanceOperationCallable() + *

  • importInstanceCallable() *

*
ExportInstance

ExportInstance

Export Redis instance data into a Redis RDB format file in Cloud Storage. *

Redis will continue serving during this operation. *

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • exportInstanceAsync(ExportInstanceRequest request) + *

  • exportInstanceAsync(ExportInstanceRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • exportInstanceAsync(String name, OutputConfig outputConfig) + *

  • exportInstanceAsync(String name, OutputConfig outputConfig) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • exportInstanceOperationCallable() - *
  • exportInstanceCallable() + *

  • exportInstanceOperationCallable() + *

  • exportInstanceCallable() *

*
FailoverInstance

FailoverInstance

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • failoverInstanceAsync(FailoverInstanceRequest request) + *

  • failoverInstanceAsync(FailoverInstanceRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • failoverInstanceAsync(InstanceName name, FailoverInstanceRequest.DataProtectionMode dataProtectionMode) - *
  • failoverInstanceAsync(String name, FailoverInstanceRequest.DataProtectionMode dataProtectionMode) + *

  • failoverInstanceAsync(InstanceName name, FailoverInstanceRequest.DataProtectionMode dataProtectionMode) + *

  • failoverInstanceAsync(String name, FailoverInstanceRequest.DataProtectionMode dataProtectionMode) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • failoverInstanceOperationCallable() - *
  • failoverInstanceCallable() + *

  • failoverInstanceOperationCallable() + *

  • failoverInstanceCallable() *

*
DeleteInstance

DeleteInstance

Deletes a specific Redis instance. Instance stops serving and data is deleted.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteInstanceAsync(DeleteInstanceRequest request) + *

  • deleteInstanceAsync(DeleteInstanceRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • deleteInstanceAsync(InstanceName name) - *
  • deleteInstanceAsync(String name) + *

  • deleteInstanceAsync(InstanceName name) + *

  • deleteInstanceAsync(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteInstanceOperationCallable() - *
  • deleteInstanceCallable() + *

  • deleteInstanceOperationCallable() + *

  • deleteInstanceCallable() *

*
RescheduleMaintenance

RescheduleMaintenance

Reschedule maintenance for a given instance in a given project and location.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • rescheduleMaintenanceAsync(RescheduleMaintenanceRequest request) + *

  • rescheduleMaintenanceAsync(RescheduleMaintenanceRequest request) *

*

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

*
    - *
  • rescheduleMaintenanceAsync(InstanceName name, RescheduleMaintenanceRequest.RescheduleType rescheduleType, Timestamp scheduleTime) - *
  • rescheduleMaintenanceAsync(String name, RescheduleMaintenanceRequest.RescheduleType rescheduleType, Timestamp scheduleTime) + *

  • rescheduleMaintenanceAsync(InstanceName name, RescheduleMaintenanceRequest.RescheduleType rescheduleType, Timestamp scheduleTime) + *

  • rescheduleMaintenanceAsync(String name, RescheduleMaintenanceRequest.RescheduleType rescheduleType, Timestamp scheduleTime) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • rescheduleMaintenanceOperationCallable() - *
  • rescheduleMaintenanceCallable() + *

  • rescheduleMaintenanceOperationCallable() + *

  • rescheduleMaintenanceCallable() *

*
* *

See the individual methods for example code. diff --git a/test/integration/goldens/storage/src/com/google/storage/v2/StorageClient.java b/test/integration/goldens/storage/src/com/google/storage/v2/StorageClient.java index 63867d4507..2285108b0e 100644 --- a/test/integration/goldens/storage/src/com/google/storage/v2/StorageClient.java +++ b/test/integration/goldens/storage/src/com/google/storage/v2/StorageClient.java @@ -79,358 +79,360 @@ * threads. In the example above, try-with-resources is used, which automatically calls close(). * * + * * * * * + * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * * - * + * * * * - * *
Methods
MethodDescriptionMethod Variants
DeleteBucket

DeleteBucket

Permanently deletes an empty bucket.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteBucket(DeleteBucketRequest request) + *

  • deleteBucket(DeleteBucketRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteBucket(BucketName name) - *
  • deleteBucket(String name) + *

  • deleteBucket(BucketName name) + *

  • deleteBucket(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteBucketCallable() + *

  • deleteBucketCallable() *

*
GetBucket

GetBucket

Returns metadata for the specified bucket.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getBucket(GetBucketRequest request) + *

  • getBucket(GetBucketRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getBucket(BucketName name) - *
  • getBucket(String name) + *

  • getBucket(BucketName name) + *

  • getBucket(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getBucketCallable() + *

  • getBucketCallable() *

*
CreateBucket

CreateBucket

Creates a new bucket.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createBucket(CreateBucketRequest request) + *

  • createBucket(CreateBucketRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createBucket(ProjectName parent, Bucket bucket, String bucketId) - *
  • createBucket(String parent, Bucket bucket, String bucketId) + *

  • createBucket(ProjectName parent, Bucket bucket, String bucketId) + *

  • createBucket(String parent, Bucket bucket, String bucketId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createBucketCallable() + *

  • createBucketCallable() *

*
ListBuckets

ListBuckets

Retrieves a list of buckets for a given project.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listBuckets(ListBucketsRequest request) + *

  • listBuckets(ListBucketsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listBuckets(ProjectName parent) - *
  • listBuckets(String parent) + *

  • listBuckets(ProjectName parent) + *

  • listBuckets(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listBucketsPagedCallable() - *
  • listBucketsCallable() + *

  • listBucketsPagedCallable() + *

  • listBucketsCallable() *

*
LockBucketRetentionPolicy

LockBucketRetentionPolicy

Locks retention policy on a bucket.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • lockBucketRetentionPolicy(LockBucketRetentionPolicyRequest request) + *

  • lockBucketRetentionPolicy(LockBucketRetentionPolicyRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • lockBucketRetentionPolicy(BucketName bucket) - *
  • lockBucketRetentionPolicy(String bucket) + *

  • lockBucketRetentionPolicy(BucketName bucket) + *

  • lockBucketRetentionPolicy(String bucket) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • lockBucketRetentionPolicyCallable() + *

  • lockBucketRetentionPolicyCallable() *

*
GetIamPolicy

GetIamPolicy

Gets the IAM policy for a specified bucket or object. The `resource` field in the request should be projects/_/buckets/<bucket_name> for a bucket or projects/_/buckets/<bucket_name>/objects/<object_name> for an object.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getIamPolicy(GetIamPolicyRequest request) + *

  • getIamPolicy(GetIamPolicyRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getIamPolicy(ResourceName resource) - *
  • getIamPolicy(String resource) + *

  • getIamPolicy(ResourceName resource) + *

  • getIamPolicy(String resource) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getIamPolicyCallable() + *

  • getIamPolicyCallable() *

*
SetIamPolicy

SetIamPolicy

Updates an IAM policy for the specified bucket or object. The `resource` field in the request should be projects/_/buckets/<bucket_name> for a bucket or projects/_/buckets/<bucket_name>/objects/<object_name> for an object.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • setIamPolicy(SetIamPolicyRequest request) + *

  • setIamPolicy(SetIamPolicyRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • setIamPolicy(ResourceName resource, Policy policy) - *
  • setIamPolicy(String resource, Policy policy) + *

  • setIamPolicy(ResourceName resource, Policy policy) + *

  • setIamPolicy(String resource, Policy policy) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • setIamPolicyCallable() + *

  • setIamPolicyCallable() *

*
TestIamPermissions

TestIamPermissions

Tests a set of permissions on the given bucket or object to see which, if any, are held by the caller. The `resource` field in the request should be projects/_/buckets/<bucket_name> for a bucket or projects/_/buckets/<bucket_name>/objects/<object_name> for an object.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • testIamPermissions(TestIamPermissionsRequest request) + *

  • testIamPermissions(TestIamPermissionsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • testIamPermissions(ResourceName resource, List permissions) - *
  • testIamPermissions(String resource, List permissions) + *

  • testIamPermissions(ResourceName resource, List<String> permissions) + *

  • testIamPermissions(String resource, List<String> permissions) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • testIamPermissionsCallable() + *

  • testIamPermissionsCallable() *

*
UpdateBucket

UpdateBucket

Updates a bucket. Equivalent to JSON API's storage.buckets.patch method.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateBucket(UpdateBucketRequest request) + *

  • updateBucket(UpdateBucketRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateBucket(Bucket bucket, FieldMask updateMask) + *

  • updateBucket(Bucket bucket, FieldMask updateMask) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateBucketCallable() + *

  • updateBucketCallable() *

*
DeleteNotification

DeleteNotification

Permanently deletes a notification subscription.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteNotification(DeleteNotificationRequest request) + *

  • deleteNotification(DeleteNotificationRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteNotification(NotificationName name) - *
  • deleteNotification(String name) + *

  • deleteNotification(NotificationName name) + *

  • deleteNotification(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteNotificationCallable() + *

  • deleteNotificationCallable() *

*
GetNotification

GetNotification

View a notification config.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getNotification(GetNotificationRequest request) + *

  • getNotification(GetNotificationRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getNotification(BucketName name) - *
  • getNotification(String name) + *

  • getNotification(BucketName name) + *

  • getNotification(String name) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getNotificationCallable() + *

  • getNotificationCallable() *

*
CreateNotification

CreateNotification

Creates a notification subscription for a given bucket. These notifications, when triggered, publish messages to the specified Pub/Sub topics. See https://cloud.google.com/storage/docs/pubsub-notifications.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createNotification(CreateNotificationRequest request) + *

  • createNotification(CreateNotificationRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createNotification(ProjectName parent, Notification notification) - *
  • createNotification(String parent, Notification notification) + *

  • createNotification(ProjectName parent, Notification notification) + *

  • createNotification(String parent, Notification notification) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createNotificationCallable() + *

  • createNotificationCallable() *

*
ListNotifications

ListNotifications

Retrieves a list of notification subscriptions for a given bucket.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listNotifications(ListNotificationsRequest request) + *

  • listNotifications(ListNotificationsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listNotifications(ProjectName parent) - *
  • listNotifications(String parent) + *

  • listNotifications(ProjectName parent) + *

  • listNotifications(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listNotificationsPagedCallable() - *
  • listNotificationsCallable() + *

  • listNotificationsPagedCallable() + *

  • listNotificationsCallable() *

*
ComposeObject

ComposeObject

Concatenates a list of existing objects into a new object in the same bucket.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • composeObject(ComposeObjectRequest request) + *

  • composeObject(ComposeObjectRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • composeObjectCallable() + *

  • composeObjectCallable() *

*
DeleteObject

DeleteObject

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the `generation` parameter is used.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteObject(DeleteObjectRequest request) + *

  • deleteObject(DeleteObjectRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteObject(String bucket, String object) - *
  • deleteObject(String bucket, String object, long generation) + *

  • deleteObject(String bucket, String object) + *

  • deleteObject(String bucket, String object, long generation) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteObjectCallable() + *

  • deleteObjectCallable() *

*
CancelResumableWrite

CancelResumableWrite

Cancels an in-progress resumable upload.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • cancelResumableWrite(CancelResumableWriteRequest request) + *

  • cancelResumableWrite(CancelResumableWriteRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • cancelResumableWrite(String uploadId) + *

  • cancelResumableWrite(String uploadId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • cancelResumableWriteCallable() + *

  • cancelResumableWriteCallable() *

*
GetObject

GetObject

Retrieves an object's metadata.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getObject(GetObjectRequest request) + *

  • getObject(GetObjectRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getObject(String bucket, String object) - *
  • getObject(String bucket, String object, long generation) + *

  • getObject(String bucket, String object) + *

  • getObject(String bucket, String object, long generation) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getObjectCallable() + *

  • getObjectCallable() *

*
ReadObject

ReadObject

Reads an object's data.

 *

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • readObjectCallable() + *

  • readObjectCallable() *

*
UpdateObject

UpdateObject

Updates an object's metadata. Equivalent to JSON API's storage.objects.patch.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateObject(UpdateObjectRequest request) + *

  • updateObject(UpdateObjectRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateObject(Object object, FieldMask updateMask) + *

  • updateObject(Object object, FieldMask updateMask) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateObjectCallable() + *

  • updateObjectCallable() *

*
WriteObject

WriteObject

Stores a new object and metadata. *

An object can be written either in a single message stream or in a resumable sequence of message streams. To write using a single stream, the client should include in the first message of the stream an `WriteObjectSpec` describing the destination bucket, object, and any preconditions. Additionally, the final message must set 'finish_write' to true, or else it is an error. *

For a resumable write, the client should instead call `StartResumableWrite()`, populating a `WriteObjectSpec` into that request. They should then attach the returned `upload_id` to the first message of each following call to `WriteObject`. If the stream is closed before finishing the upload (either explicitly by the client or due to a network error or an error response from the server), the client should do as follows: - Check the result Status of the stream, to determine if writing can be resumed on this stream or must be restarted from scratch (by calling `StartResumableWrite()`). The resumable errors are DEADLINE_EXCEEDED, INTERNAL, and UNAVAILABLE. For each case, the client should use binary exponential backoff before retrying. Additionally, writes can be resumed after RESOURCE_EXHAUSTED errors, but only after taking appropriate measures, which may include reducing aggregate send rate across clients and/or requesting a quota increase for your project. - If the call to `WriteObject` returns `ABORTED`, that indicates concurrent attempts to update the resumable write, caused either by multiple racing clients or by a single client where the previous request was timed out on the client side but nonetheless reached the server. In this case the client should take steps to prevent further concurrent writes (e.g., increase the timeouts, stop using more than one process to perform the upload, etc.), and then should follow the steps below for resuming the upload. - For resumable errors, the client should call `QueryWriteStatus()` and then continue writing from the returned `persisted_size`. This may be less than the amount of data the client previously sent. Note also that it is acceptable to send data starting at an offset earlier than the returned `persisted_size`; in this case, the service will skip data at offsets that were already persisted (without checking that it matches the previously written data), and write only the data starting from the persisted offset. This behavior can make client-side handling simpler in some cases. @@ -439,193 +441,192 @@ *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • writeObjectCallable() + *

  • writeObjectCallable() *

*
ListObjects

ListObjects

Retrieves a list of objects matching the criteria.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listObjects(ListObjectsRequest request) + *

  • listObjects(ListObjectsRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listObjects(ProjectName parent) - *
  • listObjects(String parent) + *

  • listObjects(ProjectName parent) + *

  • listObjects(String parent) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listObjectsPagedCallable() - *
  • listObjectsCallable() + *

  • listObjectsPagedCallable() + *

  • listObjectsCallable() *

*
RewriteObject

RewriteObject

Rewrites a source object to a destination object. Optionally overrides metadata.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • rewriteObject(RewriteObjectRequest request) + *

  • rewriteObject(RewriteObjectRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • rewriteObjectCallable() + *

  • rewriteObjectCallable() *

*
StartResumableWrite

StartResumableWrite

Starts a resumable write. How long the write operation remains valid, and what happens when the write operation becomes invalid, are service-dependent.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • startResumableWrite(StartResumableWriteRequest request) + *

  • startResumableWrite(StartResumableWriteRequest request) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • startResumableWriteCallable() + *

  • startResumableWriteCallable() *

*
QueryWriteStatus

QueryWriteStatus

Determines the `persisted_size` for an object that is being written, which can then be used as the `write_offset` for the next `Write()` call. *

If the object does not exist (i.e., the object has been deleted, or the first `Write()` has not yet reached the service), this method returns the error `NOT_FOUND`. *

The client **may** call `QueryWriteStatus()` at any time to determine how much data has been processed for this object. This is useful if the client is buffering data and needs to know which data can be safely evicted. For any sequence of `QueryWriteStatus()` calls for a given object name, the sequence of returned `persisted_size` values will be non-decreasing.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • queryWriteStatus(QueryWriteStatusRequest request) + *

  • queryWriteStatus(QueryWriteStatusRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • queryWriteStatus(String uploadId) + *

  • queryWriteStatus(String uploadId) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • queryWriteStatusCallable() + *

  • queryWriteStatusCallable() *

*
GetServiceAccount

GetServiceAccount

Retrieves the name of a project's Google Cloud Storage service account.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getServiceAccount(GetServiceAccountRequest request) + *

  • getServiceAccount(GetServiceAccountRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getServiceAccount(ProjectName project) - *
  • getServiceAccount(String project) + *

  • getServiceAccount(ProjectName project) + *

  • getServiceAccount(String project) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getServiceAccountCallable() + *

  • getServiceAccountCallable() *

*
CreateHmacKey

CreateHmacKey

Creates a new HMAC key for the given service account.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • createHmacKey(CreateHmacKeyRequest request) + *

  • createHmacKey(CreateHmacKeyRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • createHmacKey(ProjectName project, String serviceAccountEmail) - *
  • createHmacKey(String project, String serviceAccountEmail) + *

  • createHmacKey(ProjectName project, String serviceAccountEmail) + *

  • createHmacKey(String project, String serviceAccountEmail) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • createHmacKeyCallable() + *

  • createHmacKeyCallable() *

*
DeleteHmacKey

DeleteHmacKey

Deletes a given HMAC key. Key must be in an INACTIVE state.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • deleteHmacKey(DeleteHmacKeyRequest request) + *

  • deleteHmacKey(DeleteHmacKeyRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • deleteHmacKey(String accessId, ProjectName project) - *
  • deleteHmacKey(String accessId, String project) + *

  • deleteHmacKey(String accessId, ProjectName project) + *

  • deleteHmacKey(String accessId, String project) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • deleteHmacKeyCallable() + *

  • deleteHmacKeyCallable() *

*
GetHmacKey

GetHmacKey

Gets an existing HMAC key metadata for the given id.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • getHmacKey(GetHmacKeyRequest request) + *

  • getHmacKey(GetHmacKeyRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • getHmacKey(String accessId, ProjectName project) - *
  • getHmacKey(String accessId, String project) + *

  • getHmacKey(String accessId, ProjectName project) + *

  • getHmacKey(String accessId, String project) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • getHmacKeyCallable() + *

  • getHmacKeyCallable() *

*
ListHmacKeys

ListHmacKeys

Lists HMAC keys under a given project with the additional filters provided.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • listHmacKeys(ListHmacKeysRequest request) + *

  • listHmacKeys(ListHmacKeysRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • listHmacKeys(ProjectName project) - *
  • listHmacKeys(String project) + *

  • listHmacKeys(ProjectName project) + *

  • listHmacKeys(String project) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • listHmacKeysPagedCallable() - *
  • listHmacKeysCallable() + *

  • listHmacKeysPagedCallable() + *

  • listHmacKeysCallable() *

*
UpdateHmacKey

UpdateHmacKey

Updates a given HMAC key state between ACTIVE and INACTIVE.

 *

Request object method variants only take one parameter, a request object, which must be constructed before the call.

*
    - *
  • updateHmacKey(UpdateHmacKeyRequest request) + *

  • updateHmacKey(UpdateHmacKeyRequest request) *

*

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

*
    - *
  • updateHmacKey(HmacKeyMetadata hmacKey, FieldMask updateMask) + *

  • updateHmacKey(HmacKeyMetadata hmacKey, FieldMask updateMask) *

*

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

*
    - *
  • updateHmacKeyCallable() + *

  • updateHmacKeyCallable() *

*
* *

See the individual methods for example code.