Class SqlFlagsServiceClient (0.1.0)

Service Description: Service to manage database flags for Cloud SQL instances.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SqlFlagsServiceClient sqlFlagsServiceClient = SqlFlagsServiceClient.create()) {
   SqlFlagsListRequest request =
       SqlFlagsListRequest.newBuilder()
           .setDatabaseVersion("databaseVersion1250955997")
           .setFlagScope(SqlFlagScope.forNumber(0))
           .build();
   FlagsListResponse response = sqlFlagsServiceClient.list(request);
 }

Note: close() needs to be called on the SqlFlagsServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
List	Lists all available database flags for Cloud SQL instances.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(SqlFlagsListRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of SqlFlagsServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SqlFlagsServiceSettings sqlFlagsServiceSettings =
     SqlFlagsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SqlFlagsServiceClient sqlFlagsServiceClient =
     SqlFlagsServiceClient.create(sqlFlagsServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SqlFlagsServiceSettings sqlFlagsServiceSettings =
     SqlFlagsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SqlFlagsServiceClient sqlFlagsServiceClient =
     SqlFlagsServiceClient.create(sqlFlagsServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SqlFlagsServiceSettings sqlFlagsServiceSettings =
     SqlFlagsServiceSettings.newHttpJsonBuilder().build();
 SqlFlagsServiceClient sqlFlagsServiceClient =
     SqlFlagsServiceClient.create(sqlFlagsServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > SqlFlagsServiceClient

Static Methods

create()

public static final SqlFlagsServiceClient create()

Constructs an instance of SqlFlagsServiceClient with default settings.

Returns
Type	Description
`SqlFlagsServiceClient`

Exceptions
Type	Description
`IOException`

create(SqlFlagsServiceSettings settings)

public static final SqlFlagsServiceClient create(SqlFlagsServiceSettings settings)

Constructs an instance of SqlFlagsServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`SqlFlagsServiceSettings`

Returns
Type	Description
`SqlFlagsServiceClient`

Exceptions
Type	Description
`IOException`

create(SqlFlagsServiceStub stub)

public static final SqlFlagsServiceClient create(SqlFlagsServiceStub stub)

Constructs an instance of SqlFlagsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SqlFlagsServiceSettings).

Parameter
Name	Description
`stub`	`SqlFlagsServiceStub`

Returns
Type	Description
`SqlFlagsServiceClient`

Constructors

SqlFlagsServiceClient(SqlFlagsServiceSettings settings)

protected SqlFlagsServiceClient(SqlFlagsServiceSettings settings)

Constructs an instance of SqlFlagsServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`SqlFlagsServiceSettings`

SqlFlagsServiceClient(SqlFlagsServiceStub stub)

protected SqlFlagsServiceClient(SqlFlagsServiceStub stub)

Parameter
Name	Description
`stub`	`SqlFlagsServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getSettings()

public final @Nullable SqlFlagsServiceSettings getSettings()

Returns
Type	Description
`@org.jspecify.annotations.Nullable com.google.cloud.sql.v1.SqlFlagsServiceSettings`

getStub()

public SqlFlagsServiceStub getStub()

Returns
Type	Description
`SqlFlagsServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

list(SqlFlagsListRequest request)

public final FlagsListResponse list(SqlFlagsListRequest request)

Lists all available database flags for Cloud SQL instances.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SqlFlagsServiceClient sqlFlagsServiceClient = SqlFlagsServiceClient.create()) {
   SqlFlagsListRequest request =
       SqlFlagsListRequest.newBuilder()
           .setDatabaseVersion("databaseVersion1250955997")
           .setFlagScope(SqlFlagScope.forNumber(0))
           .build();
   FlagsListResponse response = sqlFlagsServiceClient.list(request);
 }

Parameter
Name	Description
`request`	`SqlFlagsListRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`FlagsListResponse`

listCallable()

public final UnaryCallable<SqlFlagsListRequest,FlagsListResponse> listCallable()