Class OrganizationVpcFlowLogsServiceClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient =
OrganizationVpcFlowLogsServiceClient.create()) {
VpcFlowLogsConfigName name =
VpcFlowLogsConfigName.ofOrganizationLocationVpcFlowLogsConfigName(
"[ORGANIZATION]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]");
VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient.getVpcFlowLogsConfig(name);
}
Note: close() needs to be called on the OrganizationVpcFlowLogsServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
ListVpcFlowLogsConfigs |
Lists all `VpcFlowLogsConfigs` in a given organization. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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 considered 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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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. Updating a configuration with `state=DISABLED` will fail 2. The following fields are not considered 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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteVpcFlowLogsConfig |
Deletes a specific `VpcFlowLogsConfig`. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations |
Lists information about the supported locations for this service.This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`.* **List project-visible locations:** Use the path`GET /v1/projects/{project_id}/locations`. This may include publiclocations as well as private or other locations specifically visibleto the project. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of OrganizationVpcFlowLogsServiceSettings 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
OrganizationVpcFlowLogsServiceSettings organizationVpcFlowLogsServiceSettings =
OrganizationVpcFlowLogsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient =
OrganizationVpcFlowLogsServiceClient.create(organizationVpcFlowLogsServiceSettings);
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
OrganizationVpcFlowLogsServiceSettings organizationVpcFlowLogsServiceSettings =
OrganizationVpcFlowLogsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient =
OrganizationVpcFlowLogsServiceClient.create(organizationVpcFlowLogsServiceSettings);
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
OrganizationVpcFlowLogsServiceSettings organizationVpcFlowLogsServiceSettings =
OrganizationVpcFlowLogsServiceSettings.newHttpJsonBuilder().build();
OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient =
OrganizationVpcFlowLogsServiceClient.create(organizationVpcFlowLogsServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructs an instance of OrganizationVpcFlowLogsServiceClient, using the given settings.protected -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) final voidclose()static final OrganizationVpcFlowLogsServiceClientcreate()Constructs an instance of OrganizationVpcFlowLogsServiceClient with default settings.static final OrganizationVpcFlowLogsServiceClientcreate(OrganizationVpcFlowLogsServiceSettings settings) Constructs an instance of OrganizationVpcFlowLogsServiceClient, using the given settings.static final OrganizationVpcFlowLogsServiceClientConstructs an instance of OrganizationVpcFlowLogsServiceClient, using the given stub for making calls.Creates a new `VpcFlowLogsConfig`.createVpcFlowLogsConfigAsync(LocationName parent, VpcFlowLogsConfig vpcFlowLogsConfig, VpcFlowLogsConfigName vpcFlowLogsConfigId) Creates a new `VpcFlowLogsConfig`.createVpcFlowLogsConfigAsync(LocationName parent, VpcFlowLogsConfig vpcFlowLogsConfig, String vpcFlowLogsConfigId) Creates a new `VpcFlowLogsConfig`.createVpcFlowLogsConfigAsync(OrganizationLocationName parent, VpcFlowLogsConfig vpcFlowLogsConfig, VpcFlowLogsConfigName vpcFlowLogsConfigId) Creates a new `VpcFlowLogsConfig`.createVpcFlowLogsConfigAsync(OrganizationLocationName parent, VpcFlowLogsConfig vpcFlowLogsConfig, String vpcFlowLogsConfigId) Creates a new `VpcFlowLogsConfig`.createVpcFlowLogsConfigAsync(String parent, VpcFlowLogsConfig vpcFlowLogsConfig, VpcFlowLogsConfigName vpcFlowLogsConfigId) Creates a new `VpcFlowLogsConfig`.createVpcFlowLogsConfigAsync(String parent, VpcFlowLogsConfig vpcFlowLogsConfig, String vpcFlowLogsConfigId) Creates a new `VpcFlowLogsConfig`.Creates a new `VpcFlowLogsConfig`.Creates a new `VpcFlowLogsConfig`.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> Deletes a specific `VpcFlowLogsConfig`.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> Deletes a specific `VpcFlowLogsConfig`.final OperationFuture<com.google.protobuf.Empty,OperationMetadata> Deletes a specific `VpcFlowLogsConfig`.Deletes a specific `VpcFlowLogsConfig`.final OperationCallable<DeleteVpcFlowLogsConfigRequest,com.google.protobuf.Empty, OperationMetadata> Deletes a specific `VpcFlowLogsConfig`.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final PolicygetIamPolicy(GetIamPolicyRequest request) Gets the access control policy for a resource.Gets the access control policy for a resource.final LocationgetLocation(GetLocationRequest request) Gets information about a location.Gets information about a location.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.getStub()final VpcFlowLogsConfigGets the details of a specific `VpcFlowLogsConfig`.final VpcFlowLogsConfigGets the details of a specific `VpcFlowLogsConfig`.final VpcFlowLogsConfiggetVpcFlowLogsConfig(String name) Gets the details of a specific `VpcFlowLogsConfig`.Gets the details of a specific `VpcFlowLogsConfig`.booleanbooleanlistLocations(ListLocationsRequest request) Lists information about the supported locations for this service.This method can be called in two ways:Lists information about the supported locations for this service.This method can be called in two ways:final UnaryCallable<ListLocationsRequest,OrganizationVpcFlowLogsServiceClient.ListLocationsPagedResponse> Lists information about the supported locations for this service.This method can be called in two ways:Lists all `VpcFlowLogsConfigs` in a given organization.listVpcFlowLogsConfigs(LocationName parent) Lists all `VpcFlowLogsConfigs` in a given organization.Lists all `VpcFlowLogsConfigs` in a given organization.listVpcFlowLogsConfigs(String parent) Lists all `VpcFlowLogsConfigs` in a given organization.Lists all `VpcFlowLogsConfigs` in a given organization.final UnaryCallable<ListVpcFlowLogsConfigsRequest,OrganizationVpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse> Lists all `VpcFlowLogsConfigs` in a given organization.final PolicysetIamPolicy(SetIamPolicyRequest request) Sets the access control policy on the specified resource.Sets the access control policy on the specified resource.voidshutdown()voidReturns permissions that a caller has on the specified resource.Returns permissions that a caller has on the specified resource.Updates an existing `VpcFlowLogsConfig`.updateVpcFlowLogsConfigAsync(VpcFlowLogsConfig vpcFlowLogsConfig, com.google.protobuf.FieldMask updateMask) Updates an existing `VpcFlowLogsConfig`.Updates an existing `VpcFlowLogsConfig`.Updates an existing `VpcFlowLogsConfig`.
-
Constructor Details
-
OrganizationVpcFlowLogsServiceClient
protected OrganizationVpcFlowLogsServiceClient(OrganizationVpcFlowLogsServiceSettings settings) throws IOException Constructs an instance of OrganizationVpcFlowLogsServiceClient, 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.- Throws:
IOException
-
OrganizationVpcFlowLogsServiceClient
-
-
Method Details
-
create
Constructs an instance of OrganizationVpcFlowLogsServiceClient with default settings.- Throws:
IOException
-
create
public static final OrganizationVpcFlowLogsServiceClient create(OrganizationVpcFlowLogsServiceSettings settings) throws IOException Constructs an instance of OrganizationVpcFlowLogsServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
IOException
-
create
public static final OrganizationVpcFlowLogsServiceClient create(OrganizationVpcFlowLogsServiceStub stub) Constructs an instance of OrganizationVpcFlowLogsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(OrganizationVpcFlowLogsServiceSettings). -
getSettings
-
getStub
-
getOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
getHttpJsonOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
listVpcFlowLogsConfigs
public final OrganizationVpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse listVpcFlowLogsConfigs(LocationName parent) Lists all `VpcFlowLogsConfigs` in a given organization.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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (VpcFlowLogsConfig element : organizationVpcFlowLogsServiceClient.listVpcFlowLogsConfigs(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The parent resource of the VpcFlowLogsConfig, in one of the following formats:- For project-level resources: `projects/{project_id}/locations/global`
- For organization-level resources: `organizations/{organization_id}/locations/global`
- Throws:
ApiException- if the remote call fails
-
listVpcFlowLogsConfigs
public final OrganizationVpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse listVpcFlowLogsConfigs(OrganizationLocationName parent) Lists all `VpcFlowLogsConfigs` in a given organization.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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]"); for (VpcFlowLogsConfig element : organizationVpcFlowLogsServiceClient.listVpcFlowLogsConfigs(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The parent resource of the VpcFlowLogsConfig, in one of the following formats:- For project-level resources: `projects/{project_id}/locations/global`
- For organization-level resources: `organizations/{organization_id}/locations/global`
- Throws:
ApiException- if the remote call fails
-
listVpcFlowLogsConfigs
public final OrganizationVpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse listVpcFlowLogsConfigs(String parent) Lists all `VpcFlowLogsConfigs` in a given organization.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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (VpcFlowLogsConfig element : organizationVpcFlowLogsServiceClient.listVpcFlowLogsConfigs(parent).iterateAll()) { // doThingsWith(element); } }- Parameters:
parent- Required. The parent resource of the VpcFlowLogsConfig, in one of the following formats:- For project-level resources: `projects/{project_id}/locations/global`
- For organization-level resources: `organizations/{organization_id}/locations/global`
- Throws:
ApiException- if the remote call fails
-
listVpcFlowLogsConfigs
public final OrganizationVpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse listVpcFlowLogsConfigs(ListVpcFlowLogsConfigsRequest request) Lists all `VpcFlowLogsConfigs` in a given organization.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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.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 : organizationVpcFlowLogsServiceClient.listVpcFlowLogsConfigs(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listVpcFlowLogsConfigsPagedCallable
public final UnaryCallable<ListVpcFlowLogsConfigsRequest,OrganizationVpcFlowLogsServiceClient.ListVpcFlowLogsConfigsPagedResponse> listVpcFlowLogsConfigsPagedCallable()Lists all `VpcFlowLogsConfigs` in a given organization.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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.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 = organizationVpcFlowLogsServiceClient .listVpcFlowLogsConfigsPagedCallable() .futureCall(request); // Do something. for (VpcFlowLogsConfig element : future.get().iterateAll()) { // doThingsWith(element); } } -
listVpcFlowLogsConfigsCallable
public final UnaryCallable<ListVpcFlowLogsConfigsRequest,ListVpcFlowLogsConfigsResponse> listVpcFlowLogsConfigsCallable()Lists all `VpcFlowLogsConfigs` in a given organization.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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.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 = organizationVpcFlowLogsServiceClient.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; } } } -
getVpcFlowLogsConfig
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { VpcFlowLogsConfigName name = VpcFlowLogsConfigName.ofOrganizationLocationVpcFlowLogsConfigName( "[ORGANIZATION]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]"); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient.getVpcFlowLogsConfig(name); }- Parameters:
name- Required. The resource name of the VpcFlowLogsConfig, in one of the following formats:- For project-level resources: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
- For organization-level resources: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
- Throws:
ApiException- if the remote call fails
-
getVpcFlowLogsConfig
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { String name = VpcFlowLogsConfigName.ofProjectLocationVpcFlowLogsConfigName( "[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString(); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient.getVpcFlowLogsConfig(name); }- Parameters:
name- Required. The resource name of the VpcFlowLogsConfig, in one of the following formats:- For project-level resources: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
- For organization-level resources: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
- Throws:
ApiException- if the remote call fails
-
getVpcFlowLogsConfig
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { GetVpcFlowLogsConfigRequest request = GetVpcFlowLogsConfigRequest.newBuilder() .setName( VpcFlowLogsConfigName.ofOrganizationLocationVpcFlowLogsConfigName( "[ORGANIZATION]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString()) .build(); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient.getVpcFlowLogsConfig(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { GetVpcFlowLogsConfigRequest request = GetVpcFlowLogsConfigRequest.newBuilder() .setName( VpcFlowLogsConfigName.ofOrganizationLocationVpcFlowLogsConfigName( "[ORGANIZATION]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString()) .build(); ApiFuture<VpcFlowLogsConfig> future = organizationVpcFlowLogsServiceClient.getVpcFlowLogsConfigCallable().futureCall(request); // Do something. VpcFlowLogsConfig response = future.get(); } -
createVpcFlowLogsConfigAsync
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 considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build(); VpcFlowLogsConfigName vpcFlowLogsConfigId = VpcFlowLogsConfigName.ofProjectLocationVpcFlowLogsConfigName( "[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]"); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient .createVpcFlowLogsConfigAsync(parent, vpcFlowLogsConfig, vpcFlowLogsConfigId) .get(); }- Parameters:
parent- Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats:- For project-level resources: `projects/{project_id}/locations/global`
- For organization-level resources: `organizations/{organization_id}/locations/global`
vpcFlowLogsConfig- Required. A `VpcFlowLogsConfig` resourcevpcFlowLogsConfigId- Required. ID of the `VpcFlowLogsConfig`.- Throws:
ApiException- if the remote call fails
-
createVpcFlowLogsConfigAsync
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 considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build(); String vpcFlowLogsConfigId = VpcFlowLogsConfigName.ofProjectLocationVpcFlowLogsConfigName( "[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString(); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient .createVpcFlowLogsConfigAsync(parent, vpcFlowLogsConfig, vpcFlowLogsConfigId) .get(); }- Parameters:
parent- Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats:- For project-level resources: `projects/{project_id}/locations/global`
- For organization-level resources: `organizations/{organization_id}/locations/global`
vpcFlowLogsConfig- Required. A `VpcFlowLogsConfig` resourcevpcFlowLogsConfigId- Required. ID of the `VpcFlowLogsConfig`.- Throws:
ApiException- if the remote call fails
-
createVpcFlowLogsConfigAsync
public final OperationFuture<VpcFlowLogsConfig,OperationMetadata> createVpcFlowLogsConfigAsync(OrganizationLocationName 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 considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]"); VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build(); VpcFlowLogsConfigName vpcFlowLogsConfigId = VpcFlowLogsConfigName.ofProjectLocationVpcFlowLogsConfigName( "[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]"); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient .createVpcFlowLogsConfigAsync(parent, vpcFlowLogsConfig, vpcFlowLogsConfigId) .get(); }- Parameters:
parent- Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats:- For project-level resources: `projects/{project_id}/locations/global`
- For organization-level resources: `organizations/{organization_id}/locations/global`
vpcFlowLogsConfig- Required. A `VpcFlowLogsConfig` resourcevpcFlowLogsConfigId- Required. ID of the `VpcFlowLogsConfig`.- Throws:
ApiException- if the remote call fails
-
createVpcFlowLogsConfigAsync
public final OperationFuture<VpcFlowLogsConfig,OperationMetadata> createVpcFlowLogsConfigAsync(OrganizationLocationName 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 considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]"); VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build(); String vpcFlowLogsConfigId = VpcFlowLogsConfigName.ofProjectLocationVpcFlowLogsConfigName( "[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString(); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient .createVpcFlowLogsConfigAsync(parent, vpcFlowLogsConfig, vpcFlowLogsConfigId) .get(); }- Parameters:
parent- Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats:- For project-level resources: `projects/{project_id}/locations/global`
- For organization-level resources: `organizations/{organization_id}/locations/global`
vpcFlowLogsConfig- Required. A `VpcFlowLogsConfig` resourcevpcFlowLogsConfigId- Required. ID of the `VpcFlowLogsConfig`.- Throws:
ApiException- if the remote call fails
-
createVpcFlowLogsConfigAsync
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 considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build(); VpcFlowLogsConfigName vpcFlowLogsConfigId = VpcFlowLogsConfigName.ofProjectLocationVpcFlowLogsConfigName( "[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]"); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient .createVpcFlowLogsConfigAsync(parent, vpcFlowLogsConfig, vpcFlowLogsConfigId) .get(); }- Parameters:
parent- Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats:- For project-level resources: `projects/{project_id}/locations/global`
- For organization-level resources: `organizations/{organization_id}/locations/global`
vpcFlowLogsConfig- Required. A `VpcFlowLogsConfig` resourcevpcFlowLogsConfigId- Required. ID of the `VpcFlowLogsConfig`.- Throws:
ApiException- if the remote call fails
-
createVpcFlowLogsConfigAsync
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 considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build(); String vpcFlowLogsConfigId = VpcFlowLogsConfigName.ofProjectLocationVpcFlowLogsConfigName( "[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString(); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient .createVpcFlowLogsConfigAsync(parent, vpcFlowLogsConfig, vpcFlowLogsConfigId) .get(); }- Parameters:
parent- Required. The parent resource of the VpcFlowLogsConfig to create, in one of the following formats:- For project-level resources: `projects/{project_id}/locations/global`
- For organization-level resources: `organizations/{organization_id}/locations/global`
vpcFlowLogsConfig- Required. A `VpcFlowLogsConfig` resourcevpcFlowLogsConfigId- Required. ID of the `VpcFlowLogsConfig`.- Throws:
ApiException- if the remote call fails
-
createVpcFlowLogsConfigAsync
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 considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { CreateVpcFlowLogsConfigRequest request = CreateVpcFlowLogsConfigRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setVpcFlowLogsConfigId( VpcFlowLogsConfigName.ofProjectLocationVpcFlowLogsConfigName( "[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString()) .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build()) .build(); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient.createVpcFlowLogsConfigAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createVpcFlowLogsConfigOperationCallable
public final OperationCallable<CreateVpcFlowLogsConfigRequest,VpcFlowLogsConfig, createVpcFlowLogsConfigOperationCallable()OperationMetadata> 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 considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { CreateVpcFlowLogsConfigRequest request = CreateVpcFlowLogsConfigRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setVpcFlowLogsConfigId( VpcFlowLogsConfigName.ofProjectLocationVpcFlowLogsConfigName( "[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString()) .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build()) .build(); OperationFuture<VpcFlowLogsConfig, OperationMetadata> future = organizationVpcFlowLogsServiceClient .createVpcFlowLogsConfigOperationCallable() .futureCall(request); // Do something. VpcFlowLogsConfig response = future.get(); } -
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 considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { CreateVpcFlowLogsConfigRequest request = CreateVpcFlowLogsConfigRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setVpcFlowLogsConfigId( VpcFlowLogsConfigName.ofProjectLocationVpcFlowLogsConfigName( "[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString()) .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build()) .build(); ApiFuture<Operation> future = organizationVpcFlowLogsServiceClient .createVpcFlowLogsConfigCallable() .futureCall(request); // Do something. Operation response = future.get(); } -
updateVpcFlowLogsConfigAsync
public final OperationFuture<VpcFlowLogsConfig,OperationMetadata> updateVpcFlowLogsConfigAsync(VpcFlowLogsConfig vpcFlowLogsConfig, com.google.protobuf.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. Updating a configuration with `state=DISABLED` will fail 2. The following fields are not considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { VpcFlowLogsConfig vpcFlowLogsConfig = VpcFlowLogsConfig.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient .updateVpcFlowLogsConfigAsync(vpcFlowLogsConfig, updateMask) .get(); }- Parameters:
vpcFlowLogsConfig- Required. Only fields specified in update_mask are updated.updateMask- Required. Mask of fields to update. At least one path must be supplied in this field. For example, to change the state of the configuration to ENABLED, specify `update_mask` = `"state"`, and the `vpc_flow_logs_config` would be: `vpc_flow_logs_config = { name = "projects/my-project/locations/global/vpcFlowLogsConfigs/my-config" state = "ENABLED" }`- Throws:
ApiException- if the remote call fails
-
updateVpcFlowLogsConfigAsync
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. Updating a configuration with `state=DISABLED` will fail 2. The following fields are not considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { UpdateVpcFlowLogsConfigRequest request = UpdateVpcFlowLogsConfigRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build()) .build(); VpcFlowLogsConfig response = organizationVpcFlowLogsServiceClient.updateVpcFlowLogsConfigAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateVpcFlowLogsConfigOperationCallable
public final OperationCallable<UpdateVpcFlowLogsConfigRequest,VpcFlowLogsConfig, updateVpcFlowLogsConfigOperationCallable()OperationMetadata> 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. Updating a configuration with `state=DISABLED` will fail 2. The following fields are not considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { UpdateVpcFlowLogsConfigRequest request = UpdateVpcFlowLogsConfigRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build()) .build(); OperationFuture<VpcFlowLogsConfig, OperationMetadata> future = organizationVpcFlowLogsServiceClient .updateVpcFlowLogsConfigOperationCallable() .futureCall(request); // Do something. VpcFlowLogsConfig response = future.get(); } -
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. Updating a configuration with `state=DISABLED` will fail 2. The following fields are not considered 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { UpdateVpcFlowLogsConfigRequest request = UpdateVpcFlowLogsConfigRequest.newBuilder() .setUpdateMask(FieldMask.newBuilder().build()) .setVpcFlowLogsConfig(VpcFlowLogsConfig.newBuilder().build()) .build(); ApiFuture<Operation> future = organizationVpcFlowLogsServiceClient .updateVpcFlowLogsConfigCallable() .futureCall(request); // Do something. Operation response = future.get(); } -
deleteVpcFlowLogsConfigAsync
public final OperationFuture<com.google.protobuf.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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { VpcFlowLogsConfigName name = VpcFlowLogsConfigName.ofOrganizationLocationVpcFlowLogsConfigName( "[ORGANIZATION]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]"); organizationVpcFlowLogsServiceClient.deleteVpcFlowLogsConfigAsync(name).get(); }- Parameters:
name- Required. The resource name of the VpcFlowLogsConfig, in one of the following formats:- For a project-level resource: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
- For an organization-level resource: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
- Throws:
ApiException- if the remote call fails
-
deleteVpcFlowLogsConfigAsync
public final OperationFuture<com.google.protobuf.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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { String name = VpcFlowLogsConfigName.ofProjectLocationVpcFlowLogsConfigName( "[PROJECT]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString(); organizationVpcFlowLogsServiceClient.deleteVpcFlowLogsConfigAsync(name).get(); }- Parameters:
name- Required. The resource name of the VpcFlowLogsConfig, in one of the following formats:- For a project-level resource: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
- For an organization-level resource: `organizations/{organization_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`
- Throws:
ApiException- if the remote call fails
-
deleteVpcFlowLogsConfigAsync
public final OperationFuture<com.google.protobuf.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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { DeleteVpcFlowLogsConfigRequest request = DeleteVpcFlowLogsConfigRequest.newBuilder() .setName( VpcFlowLogsConfigName.ofOrganizationLocationVpcFlowLogsConfigName( "[ORGANIZATION]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString()) .build(); organizationVpcFlowLogsServiceClient.deleteVpcFlowLogsConfigAsync(request).get(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteVpcFlowLogsConfigOperationCallable
public final OperationCallable<DeleteVpcFlowLogsConfigRequest,com.google.protobuf.Empty, deleteVpcFlowLogsConfigOperationCallable()OperationMetadata> 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { DeleteVpcFlowLogsConfigRequest request = DeleteVpcFlowLogsConfigRequest.newBuilder() .setName( VpcFlowLogsConfigName.ofOrganizationLocationVpcFlowLogsConfigName( "[ORGANIZATION]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString()) .build(); OperationFuture<Empty, OperationMetadata> future = organizationVpcFlowLogsServiceClient .deleteVpcFlowLogsConfigOperationCallable() .futureCall(request); // Do something. future.get(); } -
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { DeleteVpcFlowLogsConfigRequest request = DeleteVpcFlowLogsConfigRequest.newBuilder() .setName( VpcFlowLogsConfigName.ofOrganizationLocationVpcFlowLogsConfigName( "[ORGANIZATION]", "[LOCATION]", "[VPC_FLOW_LOGS_CONFIG]") .toString()) .build(); ApiFuture<Operation> future = organizationVpcFlowLogsServiceClient .deleteVpcFlowLogsConfigCallable() .futureCall(request); // Do something. future.get(); } -
listLocations
public final OrganizationVpcFlowLogsServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request) Lists information about the supported locations for this service.This method can be called in two ways:* **List all public locations:** Use the path `GET /v1/locations`.* **List project-visible locations:** Use the path`GET /v1/projects/{project_id}/locations`. This may include publiclocations as well as private or other locations specifically visibleto the 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Location element : organizationVpcFlowLogsServiceClient.listLocations(request).iterateAll()) { // doThingsWith(element); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listLocationsPagedCallable
public final UnaryCallable<ListLocationsRequest,OrganizationVpcFlowLogsServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()Lists information about the supported locations for this service.This method can be called in two ways:* **List all public locations:** Use the path `GET /v1/locations`.* **List project-visible locations:** Use the path`GET /v1/projects/{project_id}/locations`. This may include publiclocations as well as private or other locations specifically visibleto the 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Location> future = organizationVpcFlowLogsServiceClient.listLocationsPagedCallable().futureCall(request); // Do something. for (Location element : future.get().iterateAll()) { // doThingsWith(element); } } -
listLocationsCallable
Lists information about the supported locations for this service.This method can be called in two ways:* **List all public locations:** Use the path `GET /v1/locations`.* **List project-visible locations:** Use the path`GET /v1/projects/{project_id}/locations`. This may include publiclocations as well as private or other locations specifically visibleto the 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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListLocationsResponse response = organizationVpcFlowLogsServiceClient.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; } } } -
getLocation
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); Location response = organizationVpcFlowLogsServiceClient.getLocation(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); ApiFuture<Location> future = organizationVpcFlowLogsServiceClient.getLocationCallable().futureCall(request); // Do something. Location response = future.get(); } -
setIamPolicy
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Policy response = organizationVpcFlowLogsServiceClient.setIamPolicy(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
setIamPolicyCallable
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Policy> future = organizationVpcFlowLogsServiceClient.setIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); } -
getIamPolicy
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); Policy response = organizationVpcFlowLogsServiceClient.getIamPolicy(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); ApiFuture<Policy> future = organizationVpcFlowLogsServiceClient.getIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); } -
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.
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); TestIamPermissionsResponse response = organizationVpcFlowLogsServiceClient.testIamPermissions(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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 (OrganizationVpcFlowLogsServiceClient organizationVpcFlowLogsServiceClient = OrganizationVpcFlowLogsServiceClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(ConnectivityTestName.of("[PROJECT]", "[TEST]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); ApiFuture<TestIamPermissionsResponse> future = organizationVpcFlowLogsServiceClient.testIamPermissionsCallable().futureCall(request); // Do something. TestIamPermissionsResponse response = future.get(); } -
close
public final void close()- Specified by:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-