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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
ListAssetsRequest request =
ListAssetsRequest.newBuilder()
.setParent("parent-995424086")
.setReadTime(Timestamp.newBuilder().build())
.addAllAssetTypes(new ArrayList<String>())
.setContentType(ContentType.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Asset element : assetServiceClient.listAssets(request).iterateAll()) {
// doThingsWith(element);
}
}
Classes
Asset
Cloud asset. This includes all Google Cloud Platform resources, Cloud IAM policies, and other non-GCP assets.
Protobuf type google.cloud.asset.v1p5beta1.Asset
Asset.Builder
Cloud asset. This includes all Google Cloud Platform resources, Cloud IAM policies, and other non-GCP assets.
Protobuf type google.cloud.asset.v1p5beta1.Asset
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
ListAssetsRequest request =
ListAssetsRequest.newBuilder()
.setParent("parent-995424086")
.setReadTime(Timestamp.newBuilder().build())
.addAllAssetTypes(new ArrayList<String>())
.setContentType(ContentType.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Asset element : assetServiceClient.listAssets(request).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 for illustrative purposes only.
// It may require modifications to work in your environment.
AssetServiceSettings assetServiceSettings =
AssetServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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 for illustrative purposes only.
// It may require modifications to work in your environment.
AssetServiceSettings assetServiceSettings =
AssetServiceSettings.newBuilder()
.setTransportChannelProvider(
AssetServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
AssetServiceClient.ListAssetsFixedSizeCollection
AssetServiceClient.ListAssetsPage
AssetServiceClient.ListAssetsPagedResponse
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 listAssets to 30 seconds:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
AssetServiceSettings.Builder assetServiceSettingsBuilder = AssetServiceSettings.newBuilder();
assetServiceSettingsBuilder
.listAssetsSettings()
.setRetrySettings(
assetServiceSettingsBuilder
.listAssetsSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
AssetServiceSettings assetServiceSettings = assetServiceSettingsBuilder.build();
AssetServiceSettings.Builder
Builder for AssetServiceSettings.
ListAssetsRequest
ListAssets request.
Protobuf type google.cloud.asset.v1p5beta1.ListAssetsRequest
ListAssetsRequest.Builder
ListAssets request.
Protobuf type google.cloud.asset.v1p5beta1.ListAssetsRequest
ListAssetsResponse
ListAssets response.
Protobuf type google.cloud.asset.v1p5beta1.ListAssetsResponse
ListAssetsResponse.Builder
ListAssets response.
Protobuf type google.cloud.asset.v1p5beta1.ListAssetsResponse
Resource
Representation of a cloud resource.
Protobuf type google.cloud.asset.v1p5beta1.Resource
Resource.Builder
Representation of a cloud resource.
Protobuf type google.cloud.asset.v1p5beta1.Resource
Interfaces
AssetOrBuilder
ListAssetsRequestOrBuilder
ListAssetsResponseOrBuilder
ResourceOrBuilder
Enums
Asset.AccessContextPolicyCase
ContentType
Asset content type.
Protobuf enum google.cloud.asset.v1p5beta1.ContentType