Package com.google.cloud.resourcemanager.v3 (1.5.4)

The interfaces provided are listed below, along with usage samples.

FoldersClient

Service Description: Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.

Sample for FoldersClient:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (FoldersClient foldersClient = FoldersClient.create()) {
   FolderName name = FolderName.of("[FOLDER]");
   Folder response = foldersClient.getFolder(name);
 }

OrganizationsClient

Service Description: Allows users to manage their organization resources.

Sample for OrganizationsClient:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   OrganizationName name = OrganizationName.of("[ORGANIZATION]");
   Organization response = organizationsClient.getOrganization(name);
 }

ProjectsClient

Service Description: Manages Google Cloud Projects.

Sample for ProjectsClient:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ProjectsClient projectsClient = ProjectsClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   Project response = projectsClient.getProject(name);
 }

TagBindingsClient

Service Description: Allow users to create and manage TagBindings between TagValues and different cloud resources throughout the GCP resource hierarchy.

Sample for TagBindingsClient:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   ResourceName parent = FolderName.of("[FOLDER]");
   for (TagBinding element : tagBindingsClient.listTagBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

TagKeysClient

Service Description: Allow users to create and manage tag keys.

Sample for TagKeysClient:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   TagKeyName name = TagKeyName.of("[TAG_KEY]");
   TagKey response = tagKeysClient.getTagKey(name);
 }

TagValuesClient

Service Description: Allow users to create and manage tag values.

Sample for TagValuesClient:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   TagValueName name = TagValueName.of("[TAG_VALUE]");
   TagValue response = tagValuesClient.getTagValue(name);
 }

Classes

CreateFolderMetadata

Metadata pertaining to the Folder creation process.

Protobuf type google.cloud.resourcemanager.v3.CreateFolderMetadata

CreateFolderMetadata.Builder

Metadata pertaining to the Folder creation process.

Protobuf type google.cloud.resourcemanager.v3.CreateFolderMetadata

CreateFolderRequest

The CreateFolder request message.

Protobuf type google.cloud.resourcemanager.v3.CreateFolderRequest

CreateFolderRequest.Builder

The CreateFolder request message.

Protobuf type google.cloud.resourcemanager.v3.CreateFolderRequest

CreateProjectMetadata

A status object which is used as the metadata field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.

Protobuf type google.cloud.resourcemanager.v3.CreateProjectMetadata

CreateProjectMetadata.Builder

A status object which is used as the metadata field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.

Protobuf type google.cloud.resourcemanager.v3.CreateProjectMetadata

CreateProjectRequest

The request sent to the CreateProject method.

Protobuf type google.cloud.resourcemanager.v3.CreateProjectRequest

CreateProjectRequest.Builder

The request sent to the CreateProject method.

Protobuf type google.cloud.resourcemanager.v3.CreateProjectRequest

CreateTagBindingMetadata

Runtime operation information for creating a TagValue.

Protobuf type google.cloud.resourcemanager.v3.CreateTagBindingMetadata

CreateTagBindingMetadata.Builder

Runtime operation information for creating a TagValue.

Protobuf type google.cloud.resourcemanager.v3.CreateTagBindingMetadata

CreateTagBindingRequest

The request message to create a TagBinding.

Protobuf type google.cloud.resourcemanager.v3.CreateTagBindingRequest

CreateTagBindingRequest.Builder

The request message to create a TagBinding.

Protobuf type google.cloud.resourcemanager.v3.CreateTagBindingRequest

CreateTagKeyMetadata

Runtime operation information for creating a TagKey.

Protobuf type google.cloud.resourcemanager.v3.CreateTagKeyMetadata

CreateTagKeyMetadata.Builder

Runtime operation information for creating a TagKey.

Protobuf type google.cloud.resourcemanager.v3.CreateTagKeyMetadata

CreateTagKeyRequest

The request message for creating a TagKey.

Protobuf type google.cloud.resourcemanager.v3.CreateTagKeyRequest

CreateTagKeyRequest.Builder

The request message for creating a TagKey.

Protobuf type google.cloud.resourcemanager.v3.CreateTagKeyRequest

CreateTagValueMetadata

Runtime operation information for creating a TagValue.

Protobuf type google.cloud.resourcemanager.v3.CreateTagValueMetadata

CreateTagValueMetadata.Builder

Runtime operation information for creating a TagValue.

Protobuf type google.cloud.resourcemanager.v3.CreateTagValueMetadata

CreateTagValueRequest

The request message for creating a TagValue.

Protobuf type google.cloud.resourcemanager.v3.CreateTagValueRequest

CreateTagValueRequest.Builder

The request message for creating a TagValue.

Protobuf type google.cloud.resourcemanager.v3.CreateTagValueRequest

DeleteFolderMetadata

A status object which is used as the metadata field for the Operation returned by DeleteFolder.

Protobuf type google.cloud.resourcemanager.v3.DeleteFolderMetadata

DeleteFolderMetadata.Builder

A status object which is used as the metadata field for the Operation returned by DeleteFolder.

Protobuf type google.cloud.resourcemanager.v3.DeleteFolderMetadata

DeleteFolderRequest

The DeleteFolder request message.

Protobuf type google.cloud.resourcemanager.v3.DeleteFolderRequest

DeleteFolderRequest.Builder

The DeleteFolder request message.

Protobuf type google.cloud.resourcemanager.v3.DeleteFolderRequest

DeleteOrganizationMetadata

A status object which is used as the metadata field for the operation returned by DeleteOrganization.

Protobuf type google.cloud.resourcemanager.v3.DeleteOrganizationMetadata

DeleteOrganizationMetadata.Builder

A status object which is used as the metadata field for the operation returned by DeleteOrganization.

Protobuf type google.cloud.resourcemanager.v3.DeleteOrganizationMetadata

DeleteProjectMetadata

A status object which is used as the metadata field for the Operation returned by DeleteProject.

Protobuf type google.cloud.resourcemanager.v3.DeleteProjectMetadata

DeleteProjectMetadata.Builder

A status object which is used as the metadata field for the Operation returned by DeleteProject.

Protobuf type google.cloud.resourcemanager.v3.DeleteProjectMetadata

DeleteProjectRequest

DeleteProject method.

Protobuf type google.cloud.resourcemanager.v3.DeleteProjectRequest

DeleteProjectRequest.Builder

DeleteProject method.

Protobuf type google.cloud.resourcemanager.v3.DeleteProjectRequest

DeleteTagBindingMetadata

Runtime operation information for deleting a TagBinding.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagBindingMetadata

DeleteTagBindingMetadata.Builder

Runtime operation information for deleting a TagBinding.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagBindingMetadata

DeleteTagBindingRequest

The request message to delete a TagBinding.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagBindingRequest

DeleteTagBindingRequest.Builder

The request message to delete a TagBinding.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagBindingRequest

DeleteTagKeyMetadata

Runtime operation information for deleting a TagKey.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagKeyMetadata

DeleteTagKeyMetadata.Builder

Runtime operation information for deleting a TagKey.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagKeyMetadata

DeleteTagKeyRequest

The request message for deleting a TagKey.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagKeyRequest

DeleteTagKeyRequest.Builder

The request message for deleting a TagKey.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagKeyRequest

DeleteTagValueMetadata

Runtime operation information for deleting a TagValue.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagValueMetadata

DeleteTagValueMetadata.Builder

Runtime operation information for deleting a TagValue.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagValueMetadata

DeleteTagValueRequest

The request message for deleting a TagValue.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagValueRequest

DeleteTagValueRequest.Builder

The request message for deleting a TagValue.

Protobuf type google.cloud.resourcemanager.v3.DeleteTagValueRequest

Folder

A folder in an organization's resource hierarchy, used to organize that organization's resources.

Protobuf type google.cloud.resourcemanager.v3.Folder

Folder.Builder

A folder in an organization's resource hierarchy, used to organize that organization's resources.

Protobuf type google.cloud.resourcemanager.v3.Folder

FoldersClient

Service Description: Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.

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 (FoldersClient foldersClient = FoldersClient.create()) {
   FolderName name = FolderName.of("[FOLDER]");
   Folder response = foldersClient.getFolder(name);
 }

Note: close() needs to be called on the FoldersClient 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 FoldersSettings 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.
 FoldersSettings foldersSettings =
     FoldersSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FoldersClient foldersClient = FoldersClient.create(foldersSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 FoldersSettings foldersSettings = FoldersSettings.newBuilder().setEndpoint(myEndpoint).build();
 FoldersClient foldersClient = FoldersClient.create(foldersSettings);

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.
 FoldersSettings foldersSettings =
     FoldersSettings.newBuilder()
         .setTransportChannelProvider(
             FoldersSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 FoldersClient foldersClient = FoldersClient.create(foldersSettings);

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

FoldersClient.ListFoldersFixedSizeCollection

FoldersClient.ListFoldersPage

FoldersClient.ListFoldersPagedResponse

FoldersClient.SearchFoldersFixedSizeCollection

FoldersClient.SearchFoldersPage

FoldersClient.SearchFoldersPagedResponse

FoldersGrpc

Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.

FoldersGrpc.FoldersBlockingStub

Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.

FoldersGrpc.FoldersFutureStub

Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.

FoldersGrpc.FoldersImplBase

Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.

FoldersGrpc.FoldersStub

Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.

FoldersProto

FoldersSettings

Settings class to configure an instance of FoldersClient.

The default instance has everything set to sensible defaults:

The default service address (cloudresourcemanager.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 getFolder to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 FoldersSettings.Builder foldersSettingsBuilder = FoldersSettings.newBuilder();
 foldersSettingsBuilder
     .getFolderSettings()
     .setRetrySettings(
         foldersSettingsBuilder
             .getFolderSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 FoldersSettings foldersSettings = foldersSettingsBuilder.build();

FoldersSettings.Builder

Builder for FoldersSettings.

GetFolderRequest

The GetFolder request message.

Protobuf type google.cloud.resourcemanager.v3.GetFolderRequest

GetFolderRequest.Builder

The GetFolder request message.

Protobuf type google.cloud.resourcemanager.v3.GetFolderRequest

GetOrganizationRequest

The request sent to the GetOrganization method. The name field is required. organization_id is no longer accepted.

Protobuf type google.cloud.resourcemanager.v3.GetOrganizationRequest

GetOrganizationRequest.Builder

The request sent to the GetOrganization method. The name field is required. organization_id is no longer accepted.

Protobuf type google.cloud.resourcemanager.v3.GetOrganizationRequest

GetProjectRequest

The request sent to the GetProject method.

Protobuf type google.cloud.resourcemanager.v3.GetProjectRequest

GetProjectRequest.Builder

The request sent to the GetProject method.

Protobuf type google.cloud.resourcemanager.v3.GetProjectRequest

GetTagKeyRequest

The request message for getting a TagKey.

Protobuf type google.cloud.resourcemanager.v3.GetTagKeyRequest

GetTagKeyRequest.Builder

The request message for getting a TagKey.

Protobuf type google.cloud.resourcemanager.v3.GetTagKeyRequest

GetTagValueRequest

The request message for getting a TagValue.

Protobuf type google.cloud.resourcemanager.v3.GetTagValueRequest

GetTagValueRequest.Builder

The request message for getting a TagValue.

Protobuf type google.cloud.resourcemanager.v3.GetTagValueRequest

ListFoldersRequest

The ListFolders request message.

Protobuf type google.cloud.resourcemanager.v3.ListFoldersRequest

ListFoldersRequest.Builder

The ListFolders request message.

Protobuf type google.cloud.resourcemanager.v3.ListFoldersRequest

ListFoldersResponse

The ListFolders response message.

Protobuf type google.cloud.resourcemanager.v3.ListFoldersResponse

ListFoldersResponse.Builder

The ListFolders response message.

Protobuf type google.cloud.resourcemanager.v3.ListFoldersResponse

ListProjectsRequest

The request sent to the ListProjects method.

Protobuf type google.cloud.resourcemanager.v3.ListProjectsRequest

ListProjectsRequest.Builder

The request sent to the ListProjects method.

Protobuf type google.cloud.resourcemanager.v3.ListProjectsRequest

ListProjectsResponse

A page of the response received from the ListProjects method. A paginated response where more pages are available has next_page_token set. This token can be used in a subsequent request to retrieve the next request page. NOTE: A response may contain fewer elements than the request page_size and still have a next_page_token.

Protobuf type google.cloud.resourcemanager.v3.ListProjectsResponse

ListProjectsResponse.Builder

Protobuf type google.cloud.resourcemanager.v3.ListProjectsResponse

ListTagBindingsRequest

The request message to list all TagBindings for a parent.

Protobuf type google.cloud.resourcemanager.v3.ListTagBindingsRequest

ListTagBindingsRequest.Builder

The request message to list all TagBindings for a parent.

Protobuf type google.cloud.resourcemanager.v3.ListTagBindingsRequest

ListTagBindingsResponse

The ListTagBindings response.

Protobuf type google.cloud.resourcemanager.v3.ListTagBindingsResponse

ListTagBindingsResponse.Builder

The ListTagBindings response.

Protobuf type google.cloud.resourcemanager.v3.ListTagBindingsResponse

ListTagKeysRequest

The request message for listing all TagKeys under a parent resource.

Protobuf type google.cloud.resourcemanager.v3.ListTagKeysRequest

ListTagKeysRequest.Builder

The request message for listing all TagKeys under a parent resource.

Protobuf type google.cloud.resourcemanager.v3.ListTagKeysRequest

ListTagKeysResponse

The ListTagKeys response message.

Protobuf type google.cloud.resourcemanager.v3.ListTagKeysResponse

ListTagKeysResponse.Builder

The ListTagKeys response message.

Protobuf type google.cloud.resourcemanager.v3.ListTagKeysResponse

ListTagValuesRequest

The request message for listing TagValues for the specified TagKey.

Protobuf type google.cloud.resourcemanager.v3.ListTagValuesRequest

ListTagValuesRequest.Builder

The request message for listing TagValues for the specified TagKey.

Protobuf type google.cloud.resourcemanager.v3.ListTagValuesRequest

ListTagValuesResponse

The ListTagValues response.

Protobuf type google.cloud.resourcemanager.v3.ListTagValuesResponse

ListTagValuesResponse.Builder

The ListTagValues response.

Protobuf type google.cloud.resourcemanager.v3.ListTagValuesResponse

MoveFolderMetadata

Metadata pertaining to the folder move process.

Protobuf type google.cloud.resourcemanager.v3.MoveFolderMetadata

MoveFolderMetadata.Builder

Metadata pertaining to the folder move process.

Protobuf type google.cloud.resourcemanager.v3.MoveFolderMetadata

MoveFolderRequest

The MoveFolder request message.

Protobuf type google.cloud.resourcemanager.v3.MoveFolderRequest

MoveFolderRequest.Builder

The MoveFolder request message.

Protobuf type google.cloud.resourcemanager.v3.MoveFolderRequest

MoveProjectMetadata

A status object which is used as the metadata field for the Operation returned by MoveProject.

Protobuf type google.cloud.resourcemanager.v3.MoveProjectMetadata

MoveProjectMetadata.Builder

A status object which is used as the metadata field for the Operation returned by MoveProject.

Protobuf type google.cloud.resourcemanager.v3.MoveProjectMetadata

MoveProjectRequest

The request sent to MoveProject method.

Protobuf type google.cloud.resourcemanager.v3.MoveProjectRequest

MoveProjectRequest.Builder

The request sent to MoveProject method.

Protobuf type google.cloud.resourcemanager.v3.MoveProjectRequest

Organization

The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.

Protobuf type google.cloud.resourcemanager.v3.Organization

Organization.Builder

The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.

Protobuf type google.cloud.resourcemanager.v3.Organization

OrganizationName

OrganizationName.Builder

Builder for organizations/{organization}.

OrganizationsClient

Service Description: Allows users to manage their organization resources.

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 (OrganizationsClient organizationsClient = OrganizationsClient.create()) {
   OrganizationName name = OrganizationName.of("[ORGANIZATION]");
   Organization response = organizationsClient.getOrganization(name);
 }

Note: close() needs to be called on the OrganizationsClient 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.

This class can be customized by passing in a custom instance of OrganizationsSettings 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.
 OrganizationsSettings organizationsSettings =
     OrganizationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 OrganizationsSettings organizationsSettings =
     OrganizationsSettings.newBuilder().setEndpoint(myEndpoint).build();
 OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);

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.
 OrganizationsSettings organizationsSettings =
     OrganizationsSettings.newBuilder()
         .setTransportChannelProvider(
             OrganizationsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 OrganizationsClient organizationsClient = OrganizationsClient.create(organizationsSettings);

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

OrganizationsClient.SearchOrganizationsFixedSizeCollection

OrganizationsClient.SearchOrganizationsPage

OrganizationsClient.SearchOrganizationsPagedResponse

OrganizationsGrpc

Allows users to manage their organization resources.

OrganizationsGrpc.OrganizationsBlockingStub

Allows users to manage their organization resources.

OrganizationsGrpc.OrganizationsFutureStub

Allows users to manage their organization resources.

OrganizationsGrpc.OrganizationsImplBase

Allows users to manage their organization resources.

OrganizationsGrpc.OrganizationsStub

Allows users to manage their organization resources.

OrganizationsProto

OrganizationsSettings

Settings class to configure an instance of OrganizationsClient.

The default instance has everything set to sensible defaults:

The default service address (cloudresourcemanager.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 getOrganization to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 OrganizationsSettings.Builder organizationsSettingsBuilder = OrganizationsSettings.newBuilder();
 organizationsSettingsBuilder
     .getOrganizationSettings()
     .setRetrySettings(
         organizationsSettingsBuilder
             .getOrganizationSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OrganizationsSettings organizationsSettings = organizationsSettingsBuilder.build();

OrganizationsSettings.Builder

Builder for OrganizationsSettings.

Project

A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.

Protobuf type google.cloud.resourcemanager.v3.Project

Project.Builder

A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.

Protobuf type google.cloud.resourcemanager.v3.Project

ProjectName

ProjectName.Builder

Builder for projects/{project}.

ProjectsClient

Service Description: Manages Google Cloud Projects.

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 (ProjectsClient projectsClient = ProjectsClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   Project response = projectsClient.getProject(name);
 }

Note: close() needs to be called on the ProjectsClient 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.

This class can be customized by passing in a custom instance of ProjectsSettings 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.
 ProjectsSettings projectsSettings =
     ProjectsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProjectsClient projectsClient = ProjectsClient.create(projectsSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ProjectsSettings projectsSettings =
     ProjectsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProjectsClient projectsClient = ProjectsClient.create(projectsSettings);

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.
 ProjectsSettings projectsSettings =
     ProjectsSettings.newBuilder()
         .setTransportChannelProvider(
             ProjectsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ProjectsClient projectsClient = ProjectsClient.create(projectsSettings);

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

ProjectsClient.ListProjectsFixedSizeCollection

ProjectsClient.ListProjectsPage

ProjectsClient.ListProjectsPagedResponse

ProjectsClient.SearchProjectsFixedSizeCollection

ProjectsClient.SearchProjectsPage

ProjectsClient.SearchProjectsPagedResponse

ProjectsGrpc

Manages Google Cloud Projects.

ProjectsGrpc.ProjectsBlockingStub

Manages Google Cloud Projects.

ProjectsGrpc.ProjectsFutureStub

Manages Google Cloud Projects.

ProjectsGrpc.ProjectsImplBase

Manages Google Cloud Projects.

ProjectsGrpc.ProjectsStub

Manages Google Cloud Projects.

ProjectsProto

ProjectsSettings

Settings class to configure an instance of ProjectsClient.

The default instance has everything set to sensible defaults:

The default service address (cloudresourcemanager.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 getProject to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ProjectsSettings.Builder projectsSettingsBuilder = ProjectsSettings.newBuilder();
 projectsSettingsBuilder
     .getProjectSettings()
     .setRetrySettings(
         projectsSettingsBuilder
             .getProjectSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ProjectsSettings projectsSettings = projectsSettingsBuilder.build();

ProjectsSettings.Builder

Builder for ProjectsSettings.

SearchFoldersRequest

The request message for searching folders.

Protobuf type google.cloud.resourcemanager.v3.SearchFoldersRequest

SearchFoldersRequest.Builder

The request message for searching folders.

Protobuf type google.cloud.resourcemanager.v3.SearchFoldersRequest

SearchFoldersResponse

The response message for searching folders.

Protobuf type google.cloud.resourcemanager.v3.SearchFoldersResponse

SearchFoldersResponse.Builder

The response message for searching folders.

Protobuf type google.cloud.resourcemanager.v3.SearchFoldersResponse

SearchOrganizationsRequest

The request sent to the SearchOrganizations method.

Protobuf type google.cloud.resourcemanager.v3.SearchOrganizationsRequest

SearchOrganizationsRequest.Builder

The request sent to the SearchOrganizations method.

Protobuf type google.cloud.resourcemanager.v3.SearchOrganizationsRequest

SearchOrganizationsResponse

The response returned from the SearchOrganizations method.

Protobuf type google.cloud.resourcemanager.v3.SearchOrganizationsResponse

SearchOrganizationsResponse.Builder

The response returned from the SearchOrganizations method.

Protobuf type google.cloud.resourcemanager.v3.SearchOrganizationsResponse

SearchProjectsRequest

The request sent to the SearchProjects method.

Protobuf type google.cloud.resourcemanager.v3.SearchProjectsRequest

SearchProjectsRequest.Builder

The request sent to the SearchProjects method.

Protobuf type google.cloud.resourcemanager.v3.SearchProjectsRequest

SearchProjectsResponse

A page of the response received from the SearchProjects method. A paginated response where more pages are available has next_page_token set. This token can be used in a subsequent request to retrieve the next request page.

Protobuf type google.cloud.resourcemanager.v3.SearchProjectsResponse

SearchProjectsResponse.Builder

Protobuf type google.cloud.resourcemanager.v3.SearchProjectsResponse

TagBinding

A TagBinding represents a connection between a TagValue and a cloud resource (currently project, folder, or organization). Once a TagBinding is created, the TagValue is applied to all the descendants of the cloud resource.

Protobuf type google.cloud.resourcemanager.v3.TagBinding

TagBinding.Builder

Protobuf type google.cloud.resourcemanager.v3.TagBinding

TagBindingName

TagBindingName.Builder

Builder for tagBindings/{tag_binding}.

TagBindingsClient

Service Description: Allow users to create and manage TagBindings between TagValues and different cloud resources throughout the GCP resource hierarchy.

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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
   ResourceName parent = FolderName.of("[FOLDER]");
   for (TagBinding element : tagBindingsClient.listTagBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the TagBindingsClient 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.

This class can be customized by passing in a custom instance of TagBindingsSettings 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.
 TagBindingsSettings tagBindingsSettings =
     TagBindingsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TagBindingsClient tagBindingsClient = TagBindingsClient.create(tagBindingsSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 TagBindingsSettings tagBindingsSettings =
     TagBindingsSettings.newBuilder().setEndpoint(myEndpoint).build();
 TagBindingsClient tagBindingsClient = TagBindingsClient.create(tagBindingsSettings);

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.
 TagBindingsSettings tagBindingsSettings =
     TagBindingsSettings.newBuilder()
         .setTransportChannelProvider(
             TagBindingsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 TagBindingsClient tagBindingsClient = TagBindingsClient.create(tagBindingsSettings);

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

TagBindingsClient.ListTagBindingsFixedSizeCollection

TagBindingsClient.ListTagBindingsPage

TagBindingsClient.ListTagBindingsPagedResponse

TagBindingsGrpc

Allow users to create and manage TagBindings between TagValues and different cloud resources throughout the GCP resource hierarchy.

TagBindingsGrpc.TagBindingsBlockingStub

Allow users to create and manage TagBindings between TagValues and different cloud resources throughout the GCP resource hierarchy.

TagBindingsGrpc.TagBindingsFutureStub

Allow users to create and manage TagBindings between TagValues and different cloud resources throughout the GCP resource hierarchy.

TagBindingsGrpc.TagBindingsImplBase

Allow users to create and manage TagBindings between TagValues and different cloud resources throughout the GCP resource hierarchy.

TagBindingsGrpc.TagBindingsStub

Allow users to create and manage TagBindings between TagValues and different cloud resources throughout the GCP resource hierarchy.

TagBindingsProto

TagBindingsSettings

Settings class to configure an instance of TagBindingsClient.

The default instance has everything set to sensible defaults:

The default service address (cloudresourcemanager.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 listTagBindings to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 TagBindingsSettings.Builder tagBindingsSettingsBuilder = TagBindingsSettings.newBuilder();
 tagBindingsSettingsBuilder
     .listTagBindingsSettings()
     .setRetrySettings(
         tagBindingsSettingsBuilder
             .listTagBindingsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TagBindingsSettings tagBindingsSettings = tagBindingsSettingsBuilder.build();

TagBindingsSettings.Builder

Builder for TagBindingsSettings.

TagKey

A TagKey, used to group a set of TagValues.

Protobuf type google.cloud.resourcemanager.v3.TagKey

TagKey.Builder

A TagKey, used to group a set of TagValues.

Protobuf type google.cloud.resourcemanager.v3.TagKey

TagKeyName

TagKeyName.Builder

Builder for tagKeys/{tag_key}.

TagKeysClient

Service Description: Allow users to create and manage tag keys.

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 (TagKeysClient tagKeysClient = TagKeysClient.create()) {
   TagKeyName name = TagKeyName.of("[TAG_KEY]");
   TagKey response = tagKeysClient.getTagKey(name);
 }

Note: close() needs to be called on the TagKeysClient 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.

This class can be customized by passing in a custom instance of TagKeysSettings 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.
 TagKeysSettings tagKeysSettings =
     TagKeysSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TagKeysClient tagKeysClient = TagKeysClient.create(tagKeysSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 TagKeysSettings tagKeysSettings = TagKeysSettings.newBuilder().setEndpoint(myEndpoint).build();
 TagKeysClient tagKeysClient = TagKeysClient.create(tagKeysSettings);

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.
 TagKeysSettings tagKeysSettings =
     TagKeysSettings.newBuilder()
         .setTransportChannelProvider(
             TagKeysSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 TagKeysClient tagKeysClient = TagKeysClient.create(tagKeysSettings);

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

TagKeysClient.ListTagKeysFixedSizeCollection

TagKeysClient.ListTagKeysPage

TagKeysClient.ListTagKeysPagedResponse

TagKeysGrpc

Allow users to create and manage tag keys.

TagKeysGrpc.TagKeysBlockingStub

Allow users to create and manage tag keys.

TagKeysGrpc.TagKeysFutureStub

Allow users to create and manage tag keys.

TagKeysGrpc.TagKeysImplBase

Allow users to create and manage tag keys.

TagKeysGrpc.TagKeysStub

Allow users to create and manage tag keys.

TagKeysProto

TagKeysSettings

Settings class to configure an instance of TagKeysClient.

The default instance has everything set to sensible defaults:

The default service address (cloudresourcemanager.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 getTagKey to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 TagKeysSettings.Builder tagKeysSettingsBuilder = TagKeysSettings.newBuilder();
 tagKeysSettingsBuilder
     .getTagKeySettings()
     .setRetrySettings(
         tagKeysSettingsBuilder
             .getTagKeySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TagKeysSettings tagKeysSettings = tagKeysSettingsBuilder.build();

TagKeysSettings.Builder

Builder for TagKeysSettings.

TagValue

A TagValue is a child of a particular TagKey. This is used to group cloud resources for the purpose of controlling them using policies.

Protobuf type google.cloud.resourcemanager.v3.TagValue

TagValue.Builder

A TagValue is a child of a particular TagKey. This is used to group cloud resources for the purpose of controlling them using policies.

Protobuf type google.cloud.resourcemanager.v3.TagValue

TagValueName

TagValueName.Builder

Builder for tagValues/{tag_value}.

TagValuesClient

Service Description: Allow users to create and manage tag values.

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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
   TagValueName name = TagValueName.of("[TAG_VALUE]");
   TagValue response = tagValuesClient.getTagValue(name);
 }

Note: close() needs to be called on the TagValuesClient 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.

This class can be customized by passing in a custom instance of TagValuesSettings 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.
 TagValuesSettings tagValuesSettings =
     TagValuesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TagValuesClient tagValuesClient = TagValuesClient.create(tagValuesSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 TagValuesSettings tagValuesSettings =
     TagValuesSettings.newBuilder().setEndpoint(myEndpoint).build();
 TagValuesClient tagValuesClient = TagValuesClient.create(tagValuesSettings);

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.
 TagValuesSettings tagValuesSettings =
     TagValuesSettings.newBuilder()
         .setTransportChannelProvider(
             TagValuesSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 TagValuesClient tagValuesClient = TagValuesClient.create(tagValuesSettings);

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

TagValuesClient.ListTagValuesFixedSizeCollection

TagValuesClient.ListTagValuesPage

TagValuesClient.ListTagValuesPagedResponse

TagValuesGrpc

Allow users to create and manage tag values.

TagValuesGrpc.TagValuesBlockingStub

Allow users to create and manage tag values.

TagValuesGrpc.TagValuesFutureStub

Allow users to create and manage tag values.

TagValuesGrpc.TagValuesImplBase

Allow users to create and manage tag values.

TagValuesGrpc.TagValuesStub

Allow users to create and manage tag values.

TagValuesProto

TagValuesSettings

Settings class to configure an instance of TagValuesClient.

The default instance has everything set to sensible defaults:

The default service address (cloudresourcemanager.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 getTagValue to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 TagValuesSettings.Builder tagValuesSettingsBuilder = TagValuesSettings.newBuilder();
 tagValuesSettingsBuilder
     .getTagValueSettings()
     .setRetrySettings(
         tagValuesSettingsBuilder
             .getTagValueSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TagValuesSettings tagValuesSettings = tagValuesSettingsBuilder.build();