The interfaces provided are listed below, along with usage samples.
AssetServiceClient
Service Description: Asset service definition.
Sample for AssetServiceClient:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
AnalyzeIamPolicyRequest request =
AnalyzeIamPolicyRequest.newBuilder()
.setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
.setOptions(AnalyzeIamPolicyRequest.Options.newBuilder().build())
.build();
AnalyzeIamPolicyResponse response = assetServiceClient.analyzeIamPolicy(request);
}
Classes
AnalyzeIamPolicyRequest
A request message for AssetService.AnalyzeIamPolicy.
Protobuf type google.cloud.asset.v1p4beta1.AnalyzeIamPolicyRequest
AnalyzeIamPolicyRequest.Builder
A request message for AssetService.AnalyzeIamPolicy.
Protobuf type google.cloud.asset.v1p4beta1.AnalyzeIamPolicyRequest
AnalyzeIamPolicyRequest.Options
Contains request options.
Protobuf type google.cloud.asset.v1p4beta1.AnalyzeIamPolicyRequest.Options
AnalyzeIamPolicyRequest.Options.Builder
Contains request options.
Protobuf type google.cloud.asset.v1p4beta1.AnalyzeIamPolicyRequest.Options
AnalyzeIamPolicyResponse
A response message for AssetService.AnalyzeIamPolicy.
Protobuf type google.cloud.asset.v1p4beta1.AnalyzeIamPolicyResponse
AnalyzeIamPolicyResponse.Builder
A response message for AssetService.AnalyzeIamPolicy.
Protobuf type google.cloud.asset.v1p4beta1.AnalyzeIamPolicyResponse
AnalyzeIamPolicyResponse.IamPolicyAnalysis
An analysis message to group the query and results.
Protobuf type google.cloud.asset.v1p4beta1.AnalyzeIamPolicyResponse.IamPolicyAnalysis
AnalyzeIamPolicyResponse.IamPolicyAnalysis.Builder
An analysis message to group the query and results.
Protobuf type google.cloud.asset.v1p4beta1.AnalyzeIamPolicyResponse.IamPolicyAnalysis
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:
try (AssetServiceClient assetServiceClient = AssetServiceClient.create()) {
AnalyzeIamPolicyRequest request =
AnalyzeIamPolicyRequest.newBuilder()
.setAnalysisQuery(IamPolicyAnalysisQuery.newBuilder().build())
.setOptions(AnalyzeIamPolicyRequest.Options.newBuilder().build())
.build();
AnalyzeIamPolicyResponse response = assetServiceClient.analyzeIamPolicy(request);
}
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:
AssetServiceSettings assetServiceSettings =
AssetServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);
To customize the endpoint:
AssetServiceSettings assetServiceSettings =
AssetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
AssetServiceClient assetServiceClient = AssetServiceClient.create(assetServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
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 analyzeIamPolicy to 30 seconds:
AssetServiceSettings.Builder assetServiceSettingsBuilder = AssetServiceSettings.newBuilder();
assetServiceSettingsBuilder
.analyzeIamPolicySettings()
.setRetrySettings(
assetServiceSettingsBuilder
.analyzeIamPolicySettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
AssetServiceSettings assetServiceSettings = assetServiceSettingsBuilder.build();
AssetServiceSettings.Builder
Builder for AssetServiceSettings.
ExportIamPolicyAnalysisRequest
A request message for AssetService.ExportIamPolicyAnalysis.
Protobuf type google.cloud.asset.v1p4beta1.ExportIamPolicyAnalysisRequest
ExportIamPolicyAnalysisRequest.Builder
A request message for AssetService.ExportIamPolicyAnalysis.
Protobuf type google.cloud.asset.v1p4beta1.ExportIamPolicyAnalysisRequest
ExportIamPolicyAnalysisRequest.Options
Contains request options.
Protobuf type google.cloud.asset.v1p4beta1.ExportIamPolicyAnalysisRequest.Options
ExportIamPolicyAnalysisRequest.Options.Builder
Contains request options.
Protobuf type google.cloud.asset.v1p4beta1.ExportIamPolicyAnalysisRequest.Options
ExportIamPolicyAnalysisResponse
The export IAM policy analysis response. This message is returned by the [google.longrunning.Operations.GetOperation][] method in the returned [google.longrunning.Operation.response][] field.
Protobuf type google.cloud.asset.v1p4beta1.ExportIamPolicyAnalysisResponse
ExportIamPolicyAnalysisResponse.Builder
The export IAM policy analysis response. This message is returned by the [google.longrunning.Operations.GetOperation][] method in the returned [google.longrunning.Operation.response][] field.
Protobuf type google.cloud.asset.v1p4beta1.ExportIamPolicyAnalysisResponse
IamPolicyAnalysisOutputConfig
Output configuration for export IAM policy analysis destination.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisOutputConfig
IamPolicyAnalysisOutputConfig.Builder
Output configuration for export IAM policy analysis destination.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisOutputConfig
IamPolicyAnalysisOutputConfig.GcsDestination
A Cloud Storage location.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisOutputConfig.GcsDestination
IamPolicyAnalysisOutputConfig.GcsDestination.Builder
A Cloud Storage location.
Protobuf type
google.cloud.asset.v1p4beta1.IamPolicyAnalysisOutputConfig.GcsDestination
IamPolicyAnalysisQuery
IAM policy analysis query message.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisQuery
IamPolicyAnalysisQuery.AccessSelector
Specifies roles and/or permissions to analyze, to determine both the identities possessing them and the resources they control. If multiple values are specified, results will include identities and resources matching any of them.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisQuery.AccessSelector
IamPolicyAnalysisQuery.AccessSelector.Builder
Specifies roles and/or permissions to analyze, to determine both the identities possessing them and the resources they control. If multiple values are specified, results will include identities and resources matching any of them.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisQuery.AccessSelector
IamPolicyAnalysisQuery.Builder
IAM policy analysis query message.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisQuery
IamPolicyAnalysisQuery.IdentitySelector
Specifies an identity for which to determine resource access, based on roles assigned either directly to them or to the groups they belong to, directly or indirectly.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisQuery.IdentitySelector
IamPolicyAnalysisQuery.IdentitySelector.Builder
Specifies an identity for which to determine resource access, based on roles assigned either directly to them or to the groups they belong to, directly or indirectly.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisQuery.IdentitySelector
IamPolicyAnalysisQuery.ResourceSelector
Specifies the resource to analyze for access policies, which may be set directly on the resource, or on ancestors such as organizations, folders or projects. At least one of ResourceSelector, IdentitySelector or AccessSelector must be specified in a request.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisQuery.ResourceSelector
IamPolicyAnalysisQuery.ResourceSelector.Builder
Specifies the resource to analyze for access policies, which may be set directly on the resource, or on ancestors such as organizations, folders or projects. At least one of ResourceSelector, IdentitySelector or AccessSelector must be specified in a request.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisQuery.ResourceSelector
IamPolicyAnalysisResult
IAM Policy analysis result, consisting of one IAM policy binding and derived access control lists.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult
IamPolicyAnalysisResult.Access
A role or permission that appears in an access control list.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.Access
IamPolicyAnalysisResult.Access.Builder
A role or permission that appears in an access control list.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.Access
IamPolicyAnalysisResult.AccessControlList
An access control list, derived from the above IAM policy binding, which contains a set of resources and accesses. May include one item from each set to compose an access control entry. NOTICE that there could be multiple access control lists for one IAM policy binding. The access control lists are created based on resource and access combinations. For example, assume we have the following cases in one IAM policy binding:
- Permission P1 and P2 apply to resource R1 and R2;
- Permission P3 applies to resource R2 and R3; This will result in the following access control lists:
- AccessControlList 1: [R1, R2], [P1, P2]
- AccessControlList 2: [R2, R3], [P3]
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.AccessControlList
IamPolicyAnalysisResult.AccessControlList.Builder
An access control list, derived from the above IAM policy binding, which contains a set of resources and accesses. May include one item from each set to compose an access control entry. NOTICE that there could be multiple access control lists for one IAM policy binding. The access control lists are created based on resource and access combinations. For example, assume we have the following cases in one IAM policy binding:
- Permission P1 and P2 apply to resource R1 and R2;
- Permission P3 applies to resource R2 and R3; This will result in the following access control lists:
- AccessControlList 1: [R1, R2], [P1, P2]
- AccessControlList 2: [R2, R3], [P3]
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.AccessControlList
IamPolicyAnalysisResult.AnalysisState
Represents analysis state of each node in the result graph or non-critical errors in the response.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.AnalysisState
IamPolicyAnalysisResult.AnalysisState.Builder
Represents analysis state of each node in the result graph or non-critical errors in the response.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.AnalysisState
IamPolicyAnalysisResult.Builder
IAM Policy analysis result, consisting of one IAM policy binding and derived access control lists.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult
IamPolicyAnalysisResult.Edge
A directional edge.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.Edge
IamPolicyAnalysisResult.Edge.Builder
A directional edge.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.Edge
IamPolicyAnalysisResult.Identity
An identity that appears in an access control list.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.Identity
IamPolicyAnalysisResult.Identity.Builder
An identity that appears in an access control list.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.Identity
IamPolicyAnalysisResult.IdentityList
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.IdentityList
IamPolicyAnalysisResult.IdentityList.Builder
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.IdentityList
IamPolicyAnalysisResult.Resource
A GCP resource that appears in an access control list.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.Resource
IamPolicyAnalysisResult.Resource.Builder
A GCP resource that appears in an access control list.
Protobuf type google.cloud.asset.v1p4beta1.IamPolicyAnalysisResult.Resource