- 3.57.0 (latest)
- 3.56.0
- 3.55.0
- 3.53.0
- 3.52.0
- 3.51.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.41.0
- 3.40.0
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.28.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.2-SNAPSHOT
- 3.6.0
- 3.4.1
- 3.3.1
- 3.2.17
The interfaces provided are listed below, along with usage samples.
AssetServiceClient
Service Description: Asset service definition.
Sample for AssetServiceClient:
// 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 (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
String scope = "scope109264468";
String query = "query107944136";
List<String> assetTypes = new ArrayList<>();
for (StandardResourceMetadata element :
assetServiceClient.searchAllResources(scope, query, assetTypes).iterateAll()) {
// doThingsWith(element);
}
}
Classes
AssetProto
AssetServiceClient
Service Description: Asset service definition.
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 (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
String scope = "scope109264468";
String query = "query107944136";
List<String> assetTypes = new ArrayList<>();
for (StandardResourceMetadata element :
assetServiceClient.searchAllResources(scope, query, assetTypes).iterateAll()) {
// doThingsWith(element);
}
}
Note: close() needs to be called on the AssetServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AssetServiceSettings 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
AssetServiceSettings assetServiceSettings =
AssetServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);
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
AssetServiceSettings assetServiceSettings =
AssetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);
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
AssetServiceSettings assetServiceSettings = AssetServiceSettings.newHttpJsonBuilder().build();
AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
AssetServiceClient.SearchAllIamPoliciesFixedSizeCollection
AssetServiceClient.SearchAllIamPoliciesPage
AssetServiceClient.SearchAllIamPoliciesPagedResponse
AssetServiceClient.SearchAllResourcesFixedSizeCollection
AssetServiceClient.SearchAllResourcesPage
AssetServiceClient.SearchAllResourcesPagedResponse
AssetServiceGrpc
Asset service definition.
AssetServiceGrpc.AssetServiceBlockingStub
Asset service definition.
AssetServiceGrpc.AssetServiceFutureStub
Asset service definition.
AssetServiceGrpc.AssetServiceImplBase
Asset service definition.
AssetServiceGrpc.AssetServiceStub
Asset service definition.
AssetServiceProto
AssetServiceSettings
Settings class to configure an instance of AssetServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (cloudasset.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of searchAllResources to 30 seconds:
// 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
AssetServiceSettings.Builder assetServiceSettingsBuilder = AssetServiceSettings.newBuilder();
assetServiceSettingsBuilder
.searchAllResourcesSettings()
.setRetrySettings(
assetServiceSettingsBuilder.searchAllResourcesSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
AssetServiceSettings assetServiceSettings = assetServiceSettingsBuilder.build();
AssetServiceSettings.Builder
Builder for AssetServiceSettings.
IamPolicySearchResult
The result for a IAM Policy search.
Protobuf type google.cloud.asset.v1p1beta1.IamPolicySearchResult
IamPolicySearchResult.Builder
The result for a IAM Policy search.
Protobuf type google.cloud.asset.v1p1beta1.IamPolicySearchResult
IamPolicySearchResult.Explanation
Explanation about the IAM policy search result.
Protobuf type google.cloud.asset.v1p1beta1.IamPolicySearchResult.Explanation
IamPolicySearchResult.Explanation.Builder
Explanation about the IAM policy search result.
Protobuf type google.cloud.asset.v1p1beta1.IamPolicySearchResult.Explanation
Permissions
IAM permissions
Protobuf type google.cloud.asset.v1p1beta1.Permissions
Permissions.Builder
IAM permissions
Protobuf type google.cloud.asset.v1p1beta1.Permissions
SearchAllIamPoliciesRequest
Search all IAM policies request.
Protobuf type google.cloud.asset.v1p1beta1.SearchAllIamPoliciesRequest
SearchAllIamPoliciesRequest.Builder
Search all IAM policies request.
Protobuf type google.cloud.asset.v1p1beta1.SearchAllIamPoliciesRequest
SearchAllIamPoliciesResponse
Search all IAM policies response.
Protobuf type google.cloud.asset.v1p1beta1.SearchAllIamPoliciesResponse
SearchAllIamPoliciesResponse.Builder
Search all IAM policies response.
Protobuf type google.cloud.asset.v1p1beta1.SearchAllIamPoliciesResponse
SearchAllResourcesRequest
Search all resources request.
Protobuf type google.cloud.asset.v1p1beta1.SearchAllResourcesRequest
SearchAllResourcesRequest.Builder
Search all resources request.
Protobuf type google.cloud.asset.v1p1beta1.SearchAllResourcesRequest
SearchAllResourcesResponse
Search all resources response.
Protobuf type google.cloud.asset.v1p1beta1.SearchAllResourcesResponse
SearchAllResourcesResponse.Builder
Search all resources response.
Protobuf type google.cloud.asset.v1p1beta1.SearchAllResourcesResponse
StandardResourceMetadata
The standard metadata of a cloud resource.
Protobuf type google.cloud.asset.v1p1beta1.StandardResourceMetadata
StandardResourceMetadata.Builder
The standard metadata of a cloud resource.
Protobuf type google.cloud.asset.v1p1beta1.StandardResourceMetadata