Class VpcFlowLogsServiceClient (1.55.0)

Version 1.55.0

• 1.56.0 (latest)
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.1.10

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

Service Description: The VPC Flow Logs service in the Google Cloud Network Management API provides configurations that generate Flow Logs. The service and the configuration resources created using this service are global.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   VpcFlowLogsConfigName name =
       VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]");
   VpcFlowLogsConfig response = vpcFlowLogsServiceClient.getVpcFlowLogsConfig(name);
 }
 

Note: close() needs to be called on the VpcFlowLogsServiceClient 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
ListVpcFlowLogsConfigs	Lists all VpcFlowLogsConfigs in a given project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listVpcFlowLogsConfigs(ListVpcFlowLogsConfigsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listVpcFlowLogsConfigs(LocationName parent) listVpcFlowLogsConfigs(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. listVpcFlowLogsConfigsPagedCallable() listVpcFlowLogsConfigsCallable()
GetVpcFlowLogsConfig	Gets the details of a specific VpcFlowLogsConfig.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getVpcFlowLogsConfig(GetVpcFlowLogsConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getVpcFlowLogsConfig(VpcFlowLogsConfigName name) getVpcFlowLogsConfig(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. getVpcFlowLogsConfigCallable()
CreateVpcFlowLogsConfig	Creates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description	Request object method variants only take one parameter, a request object, which must be constructed before the call. createVpcFlowLogsConfigAsync(CreateVpcFlowLogsConfigRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. createVpcFlowLogsConfigAsync(LocationName parent, VpcFlowLogsConfig vpcFlowLogsConfig, VpcFlowLogsConfigName vpcFlowLogsConfigId) createVpcFlowLogsConfigAsync(LocationName parent, VpcFlowLogsConfig vpcFlowLogsConfig, String vpcFlowLogsConfigId) createVpcFlowLogsConfigAsync(String parent, VpcFlowLogsConfig vpcFlowLogsConfig, VpcFlowLogsConfigName vpcFlowLogsConfigId) createVpcFlowLogsConfigAsync(String parent, VpcFlowLogsConfig vpcFlowLogsConfig, String vpcFlowLogsConfigId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createVpcFlowLogsConfigOperationCallable() createVpcFlowLogsConfigCallable()
UpdateVpcFlowLogsConfig	Updates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateVpcFlowLogsConfigAsync(UpdateVpcFlowLogsConfigRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. updateVpcFlowLogsConfigAsync(VpcFlowLogsConfig vpcFlowLogsConfig, 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. updateVpcFlowLogsConfigOperationCallable() updateVpcFlowLogsConfigCallable()
DeleteVpcFlowLogsConfig	Deletes a specific VpcFlowLogsConfig.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteVpcFlowLogsConfigAsync(DeleteVpcFlowLogsConfigRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. deleteVpcFlowLogsConfigAsync(VpcFlowLogsConfigName name) deleteVpcFlowLogsConfigAsync(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. deleteVpcFlowLogsConfigOperationCallable() deleteVpcFlowLogsConfigCallable()
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) 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()
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) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replacesany existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.	Request object method variants only take one parameter, a request object, which must be constructed before the call. 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()
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) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
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) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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 VpcFlowLogsServiceSettings 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
 VpcFlowLogsServiceSettings vpcFlowLogsServiceSettings =
     VpcFlowLogsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VpcFlowLogsServiceClient vpcFlowLogsServiceClient =
     VpcFlowLogsServiceClient.create(vpcFlowLogsServiceSettings);
 

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
 VpcFlowLogsServiceSettings vpcFlowLogsServiceSettings =
     VpcFlowLogsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 VpcFlowLogsServiceClient vpcFlowLogsServiceClient =
     VpcFlowLogsServiceClient.create(vpcFlowLogsServiceSettings);
 

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
 VpcFlowLogsServiceSettings vpcFlowLogsServiceSettings =
     VpcFlowLogsServiceSettings.newHttpJsonBuilder().build();
 VpcFlowLogsServiceClient vpcFlowLogsServiceClient =
     VpcFlowLogsServiceClient.create(vpcFlowLogsServiceSettings);
 

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

Inheritance

java.lang.Object > VpcFlowLogsServiceClient

Static Methods

create()

public static final VpcFlowLogsServiceClient create()

Constructs an instance of VpcFlowLogsServiceClient with default settings.

Returns
Type	Description
VpcFlowLogsServiceClient

Exceptions
Type	Description
IOException

create(VpcFlowLogsServiceSettings settings)

public static final VpcFlowLogsServiceClient create(VpcFlowLogsServiceSettings settings)

Constructs an instance of VpcFlowLogsServiceClient, 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	VpcFlowLogsServiceSettings

Returns
Type	Description
VpcFlowLogsServiceClient

Exceptions
Type	Description
IOException

create(VpcFlowLogsServiceStub stub)

public static final VpcFlowLogsServiceClient create(VpcFlowLogsServiceStub stub)

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

Parameter
Name	Description
stub	VpcFlowLogsServiceStub

Returns
Type	Description
VpcFlowLogsServiceClient

Constructors

VpcFlowLogsServiceClient(VpcFlowLogsServiceSettings settings)

protected VpcFlowLogsServiceClient(VpcFlowLogsServiceSettings settings)

Constructs an instance of VpcFlowLogsServiceClient, 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	VpcFlowLogsServiceSettings

VpcFlowLogsServiceClient(VpcFlowLogsServiceStub stub)

protected VpcFlowLogsServiceClient(VpcFlowLogsServiceStub stub)

Parameter
Name	Description
stub	VpcFlowLogsServiceStub

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()

createVpcFlowLogsConfigAsync(CreateVpcFlowLogsConfigRequest request)

public final OperationFuture<VpcFlowLogsConfig,OperationMetadata> createVpcFlowLogsConfigAsync(CreateVpcFlowLogsConfigRequest request)

Creates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   CreateVpcFlowLogsConfigRequest request =
       CreateVpcFlowLogsConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVpcFlowLogsConfigId(
               VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]")
                   .toString())
           .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build())
           .build();
   VpcFlowLogsConfig response =
       vpcFlowLogsServiceClient.createVpcFlowLogsConfigAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<VpcFlowLogsConfig,OperationMetadata>

createVpcFlowLogsConfigAsync(LocationName parent, VpcFlowLogsConfig vpcFlowLogsConfig, VpcFlowLogsConfigName vpcFlowLogsConfigId)

public final OperationFuture<VpcFlowLogsConfig,OperationMetadata> createVpcFlowLogsConfigAsync(LocationName parent, VpcFlowLogsConfig vpcFlowLogsConfig, VpcFlowLogsConfigName vpcFlowLogsConfigId)

Creates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build();
   VpcFlowLogsConfigName vpcFlowLogsConfigId =
       VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]");
   VpcFlowLogsConfig response =
       vpcFlowLogsServiceClient
           .createVpcFlowLogsConfigAsync(parent, vpcFlowLogsConfig, vpcFlowLogsConfigId)
           .get();
 }
 

Parameters
Name	Description
parent	LocationName Required. The parent resource of the VPC Flow Logs configuration to create: projects/{project_id}/locations/global
vpcFlowLogsConfig	VpcFlowLogsConfig Required. A VpcFlowLogsConfig resource
vpcFlowLogsConfigId	VpcFlowLogsConfigName Required. ID of the VpcFlowLogsConfig.

Returns
Type	Description
OperationFuture<VpcFlowLogsConfig,OperationMetadata>

createVpcFlowLogsConfigAsync(LocationName parent, VpcFlowLogsConfig vpcFlowLogsConfig, String vpcFlowLogsConfigId)

public final OperationFuture<VpcFlowLogsConfig,OperationMetadata> createVpcFlowLogsConfigAsync(LocationName parent, VpcFlowLogsConfig vpcFlowLogsConfig, String vpcFlowLogsConfigId)

Creates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build();
   String vpcFlowLogsConfigId =
       VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]").toString();
   VpcFlowLogsConfig response =
       vpcFlowLogsServiceClient
           .createVpcFlowLogsConfigAsync(parent, vpcFlowLogsConfig, vpcFlowLogsConfigId)
           .get();
 }
 

Parameters
Name	Description
parent	LocationName Required. The parent resource of the VPC Flow Logs configuration to create: projects/{project_id}/locations/global
vpcFlowLogsConfig	VpcFlowLogsConfig Required. A VpcFlowLogsConfig resource
vpcFlowLogsConfigId	String Required. ID of the VpcFlowLogsConfig.

Returns
Type	Description
OperationFuture<VpcFlowLogsConfig,OperationMetadata>

createVpcFlowLogsConfigAsync(String parent, VpcFlowLogsConfig vpcFlowLogsConfig, VpcFlowLogsConfigName vpcFlowLogsConfigId)

public final OperationFuture<VpcFlowLogsConfig,OperationMetadata> createVpcFlowLogsConfigAsync(String parent, VpcFlowLogsConfig vpcFlowLogsConfig, VpcFlowLogsConfigName vpcFlowLogsConfigId)

Creates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build();
   VpcFlowLogsConfigName vpcFlowLogsConfigId =
       VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]");
   VpcFlowLogsConfig response =
       vpcFlowLogsServiceClient
           .createVpcFlowLogsConfigAsync(parent, vpcFlowLogsConfig, vpcFlowLogsConfigId)
           .get();
 }
 

Parameters
Name	Description
parent	String Required. The parent resource of the VPC Flow Logs configuration to create: projects/{project_id}/locations/global
vpcFlowLogsConfig	VpcFlowLogsConfig Required. A VpcFlowLogsConfig resource
vpcFlowLogsConfigId	VpcFlowLogsConfigName Required. ID of the VpcFlowLogsConfig.

Returns
Type	Description
OperationFuture<VpcFlowLogsConfig,OperationMetadata>

createVpcFlowLogsConfigAsync(String parent, VpcFlowLogsConfig vpcFlowLogsConfig, String vpcFlowLogsConfigId)

public final OperationFuture<VpcFlowLogsConfig,OperationMetadata> createVpcFlowLogsConfigAsync(String parent, VpcFlowLogsConfig vpcFlowLogsConfig, String vpcFlowLogsConfigId)

Creates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build();
   String vpcFlowLogsConfigId =
       VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]").toString();
   VpcFlowLogsConfig response =
       vpcFlowLogsServiceClient
           .createVpcFlowLogsConfigAsync(parent, vpcFlowLogsConfig, vpcFlowLogsConfigId)
           .get();
 }
 

Parameters
Name	Description
parent	String Required. The parent resource of the VPC Flow Logs configuration to create: projects/{project_id}/locations/global
vpcFlowLogsConfig	VpcFlowLogsConfig Required. A VpcFlowLogsConfig resource
vpcFlowLogsConfigId	String Required. ID of the VpcFlowLogsConfig.

Returns
Type	Description
OperationFuture<VpcFlowLogsConfig,OperationMetadata>

createVpcFlowLogsConfigCallable()

public final UnaryCallable<CreateVpcFlowLogsConfigRequest,Operation> createVpcFlowLogsConfigCallable()

Creates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   CreateVpcFlowLogsConfigRequest request =
       CreateVpcFlowLogsConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVpcFlowLogsConfigId(
               VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]")
                   .toString())
           .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       vpcFlowLogsServiceClient.createVpcFlowLogsConfigCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateVpcFlowLogsConfigRequest,Operation>

createVpcFlowLogsConfigOperationCallable()

public final OperationCallable<CreateVpcFlowLogsConfigRequest,VpcFlowLogsConfig,OperationMetadata> createVpcFlowLogsConfigOperationCallable()

Creates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   CreateVpcFlowLogsConfigRequest request =
       CreateVpcFlowLogsConfigRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setVpcFlowLogsConfigId(
               VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]")
                   .toString())
           .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build())
           .build();
   OperationFuture<VpcFlowLogsConfig, OperationMetadata> future =
       vpcFlowLogsServiceClient.createVpcFlowLogsConfigOperationCallable().futureCall(request);
   // Do something.
   VpcFlowLogsConfig response = future.get();
 }
 

Returns
Type	Description
OperationCallable<CreateVpcFlowLogsConfigRequest,VpcFlowLogsConfig,OperationMetadata>

deleteVpcFlowLogsConfigAsync(DeleteVpcFlowLogsConfigRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteVpcFlowLogsConfigAsync(DeleteVpcFlowLogsConfigRequest request)

Deletes a specific VpcFlowLogsConfig.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   DeleteVpcFlowLogsConfigRequest request =
       DeleteVpcFlowLogsConfigRequest.newBuilder()
           .setName(
               VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]")
                   .toString())
           .build();
   vpcFlowLogsServiceClient.deleteVpcFlowLogsConfigAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Empty,OperationMetadata>

deleteVpcFlowLogsConfigAsync(VpcFlowLogsConfigName name)

public final OperationFuture<Empty,OperationMetadata> deleteVpcFlowLogsConfigAsync(VpcFlowLogsConfigName name)

Deletes a specific VpcFlowLogsConfig.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   VpcFlowLogsConfigName name =
       VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]");
   vpcFlowLogsServiceClient.deleteVpcFlowLogsConfigAsync(name).get();
 }
 

Parameter
Name	Description
name	VpcFlowLogsConfigName Required. VpcFlowLogsConfig resource name using the form: projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}

Returns
Type	Description
OperationFuture<Empty,OperationMetadata>

deleteVpcFlowLogsConfigAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteVpcFlowLogsConfigAsync(String name)

Deletes a specific VpcFlowLogsConfig.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   String name =
       VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]").toString();
   vpcFlowLogsServiceClient.deleteVpcFlowLogsConfigAsync(name).get();
 }
 

Parameter
Name	Description
name	String Required. VpcFlowLogsConfig resource name using the form: projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}

Returns
Type	Description
OperationFuture<Empty,OperationMetadata>

deleteVpcFlowLogsConfigCallable()

public final UnaryCallable<DeleteVpcFlowLogsConfigRequest,Operation> deleteVpcFlowLogsConfigCallable()

Deletes a specific VpcFlowLogsConfig.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   DeleteVpcFlowLogsConfigRequest request =
       DeleteVpcFlowLogsConfigRequest.newBuilder()
           .setName(
               VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       vpcFlowLogsServiceClient.deleteVpcFlowLogsConfigCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteVpcFlowLogsConfigRequest,Operation>

deleteVpcFlowLogsConfigOperationCallable()

public final OperationCallable<DeleteVpcFlowLogsConfigRequest,Empty,OperationMetadata> deleteVpcFlowLogsConfigOperationCallable()

Deletes a specific VpcFlowLogsConfig.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   DeleteVpcFlowLogsConfigRequest request =
       DeleteVpcFlowLogsConfigRequest.newBuilder()
           .setName(
               VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]")
                   .toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       vpcFlowLogsServiceClient.deleteVpcFlowLogsConfigOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteVpcFlowLogsConfigRequest,Empty,OperationMetadata>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
OperationsClient

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

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

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = vpcFlowLogsServiceClient.getIamPolicy(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

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

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       vpcFlowLogsServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = vpcFlowLogsServiceClient.getLocation(request);
 }
 

Parameter
Name	Description
request	com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       vpcFlowLogsServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
OperationsClient

getSettings()

public final VpcFlowLogsServiceSettings getSettings()

Returns
Type	Description
VpcFlowLogsServiceSettings

getStub()

public VpcFlowLogsServiceStub getStub()

Returns
Type	Description
VpcFlowLogsServiceStub

getVpcFlowLogsConfig(GetVpcFlowLogsConfigRequest request)

public final VpcFlowLogsConfig getVpcFlowLogsConfig(GetVpcFlowLogsConfigRequest request)

Gets the details of a specific VpcFlowLogsConfig.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   GetVpcFlowLogsConfigRequest request =
       GetVpcFlowLogsConfigRequest.newBuilder()
           .setName(
               VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]")
                   .toString())
           .build();
   VpcFlowLogsConfig response = vpcFlowLogsServiceClient.getVpcFlowLogsConfig(request);
 }
 

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

Returns
Type	Description
VpcFlowLogsConfig

getVpcFlowLogsConfig(VpcFlowLogsConfigName name)

public final VpcFlowLogsConfig getVpcFlowLogsConfig(VpcFlowLogsConfigName name)

Gets the details of a specific VpcFlowLogsConfig.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   VpcFlowLogsConfigName name =
       VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]");
   VpcFlowLogsConfig response = vpcFlowLogsServiceClient.getVpcFlowLogsConfig(name);
 }
 

Parameter
Name	Description
name	VpcFlowLogsConfigName Required. VpcFlowLogsConfig resource name using the form: projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}

Returns
Type	Description
VpcFlowLogsConfig

getVpcFlowLogsConfig(String name)

public final VpcFlowLogsConfig getVpcFlowLogsConfig(String name)

Gets the details of a specific VpcFlowLogsConfig.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   String name =
       VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]").toString();
   VpcFlowLogsConfig response = vpcFlowLogsServiceClient.getVpcFlowLogsConfig(name);
 }
 

Parameter
Name	Description
name	String Required. VpcFlowLogsConfig resource name using the form: projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}

Returns
Type	Description
VpcFlowLogsConfig

getVpcFlowLogsConfigCallable()

public final UnaryCallable<GetVpcFlowLogsConfigRequest,VpcFlowLogsConfig> getVpcFlowLogsConfigCallable()

Gets the details of a specific VpcFlowLogsConfig.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   GetVpcFlowLogsConfigRequest request =
       GetVpcFlowLogsConfigRequest.newBuilder()
           .setName(
               VpcFlowLogsConfigName.of("[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]")
                   .toString())
           .build();
   ApiFuture<VpcFlowLogsConfig> future =
       vpcFlowLogsServiceClient.getVpcFlowLogsConfigCallable().futureCall(request);
   // Do something.
   VpcFlowLogsConfig response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetVpcFlowLogsConfigRequest,VpcFlowLogsConfig>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listLocations(ListLocationsRequest request)

public final VpcFlowLogsServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : vpcFlowLogsServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
VpcFlowLogsServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         vpcFlowLogsServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,VpcFlowLogsServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       vpcFlowLogsServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listVpcFlowLogsConfigs(ListVpcFlowLogsConfigsRequest request)

public final VpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse listVpcFlowLogsConfigs(ListVpcFlowLogsConfigsRequest request)

Lists all VpcFlowLogsConfigs in a given project.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   ListVpcFlowLogsConfigsRequest request =
       ListVpcFlowLogsConfigsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (VpcFlowLogsConfig element :
       vpcFlowLogsServiceClient.listVpcFlowLogsConfigs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
VpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse

listVpcFlowLogsConfigs(LocationName parent)

public final VpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse listVpcFlowLogsConfigs(LocationName parent)

Lists all VpcFlowLogsConfigs in a given project.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (VpcFlowLogsConfig element :
       vpcFlowLogsServiceClient.listVpcFlowLogsConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	LocationName Required. The parent resource of the VpcFlowLogsConfig: projects/{project_id}/locations/global

Returns
Type	Description
VpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse

listVpcFlowLogsConfigs(String parent)

public final VpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse listVpcFlowLogsConfigs(String parent)

Lists all VpcFlowLogsConfigs in a given project.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (VpcFlowLogsConfig element :
       vpcFlowLogsServiceClient.listVpcFlowLogsConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The parent resource of the VpcFlowLogsConfig: projects/{project_id}/locations/global

Returns
Type	Description
VpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse

listVpcFlowLogsConfigsCallable()

public final UnaryCallable<ListVpcFlowLogsConfigsRequest,ListVpcFlowLogsConfigsResponse> listVpcFlowLogsConfigsCallable()

Lists all VpcFlowLogsConfigs in a given project.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   ListVpcFlowLogsConfigsRequest request =
       ListVpcFlowLogsConfigsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListVpcFlowLogsConfigsResponse response =
         vpcFlowLogsServiceClient.listVpcFlowLogsConfigsCallable().call(request);
     for (VpcFlowLogsConfig element : response.getVpcFlowLogsConfigsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListVpcFlowLogsConfigsRequest,ListVpcFlowLogsConfigsResponse>

listVpcFlowLogsConfigsPagedCallable()

public final UnaryCallable<ListVpcFlowLogsConfigsRequest,VpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse> listVpcFlowLogsConfigsPagedCallable()

Lists all VpcFlowLogsConfigs in a given project.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   ListVpcFlowLogsConfigsRequest request =
       ListVpcFlowLogsConfigsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<VpcFlowLogsConfig> future =
       vpcFlowLogsServiceClient.listVpcFlowLogsConfigsPagedCallable().futureCall(request);
   // Do something.
   for (VpcFlowLogsConfig element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListVpcFlowLogsConfigsRequest,ListVpcFlowLogsConfigsPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = vpcFlowLogsServiceClient.setIamPolicy(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       vpcFlowLogsServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

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.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = vpcFlowLogsServiceClient.testIamPermissions(request);
 }
 

Parameter
Name	Description
request	com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

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.

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       vpcFlowLogsServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateVpcFlowLogsConfigAsync(UpdateVpcFlowLogsConfigRequest request)

public final OperationFuture<VpcFlowLogsConfig,OperationMetadata> updateVpcFlowLogsConfigAsync(UpdateVpcFlowLogsConfigRequest request)

Updates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   UpdateVpcFlowLogsConfigRequest request =
       UpdateVpcFlowLogsConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build())
           .build();
   VpcFlowLogsConfig response =
       vpcFlowLogsServiceClient.updateVpcFlowLogsConfigAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<VpcFlowLogsConfig,OperationMetadata>

updateVpcFlowLogsConfigAsync(VpcFlowLogsConfig vpcFlowLogsConfig, FieldMask updateMask)

public final OperationFuture<VpcFlowLogsConfig,OperationMetadata> updateVpcFlowLogsConfigAsync(VpcFlowLogsConfig vpcFlowLogsConfig, FieldMask updateMask)

Updates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   VpcFlowLogsConfig response =
       vpcFlowLogsServiceClient
           .updateVpcFlowLogsConfigAsync(vpcFlowLogsConfig, updateMask)
           .get();
 }
 

Parameters
Name	Description
vpcFlowLogsConfig	VpcFlowLogsConfig Required. Only fields specified in update_mask are updated.
updateMask	FieldMask Required. Mask of fields to update. At least one path must be supplied in this field.

Returns
Type	Description
OperationFuture<VpcFlowLogsConfig,OperationMetadata>

updateVpcFlowLogsConfigCallable()

public final UnaryCallable<UpdateVpcFlowLogsConfigRequest,Operation> updateVpcFlowLogsConfigCallable()

Updates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   UpdateVpcFlowLogsConfigRequest request =
       UpdateVpcFlowLogsConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       vpcFlowLogsServiceClient.updateVpcFlowLogsConfigCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateVpcFlowLogsConfigRequest,Operation>

updateVpcFlowLogsConfigOperationCallable()

public final OperationCallable<UpdateVpcFlowLogsConfigRequest,VpcFlowLogsConfig,OperationMetadata> updateVpcFlowLogsConfigOperationCallable()

Updates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. The following fields are not considrered as settings for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

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 (VpcFlowLogsServiceClient vpcFlowLogsServiceClient = VpcFlowLogsServiceClient.create()) {
   UpdateVpcFlowLogsConfigRequest request =
       UpdateVpcFlowLogsConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build())
           .build();
   OperationFuture<VpcFlowLogsConfig, OperationMetadata> future =
       vpcFlowLogsServiceClient.updateVpcFlowLogsConfigOperationCallable().futureCall(request);
   // Do something.
   VpcFlowLogsConfig response = future.get();
 }
 

Returns
Type	Description
OperationCallable<UpdateVpcFlowLogsConfigRequest,VpcFlowLogsConfig,OperationMetadata>