@Generated("by gapic-generator-java")
Package com.google.cloud.resourcemanager.v3
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 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 (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 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 (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 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 (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 Google Cloud resources throughout the GCP resource hierarchy.
Sample for TagBindingsClient:
// 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 (TagBindingsClient tagBindingsClient = TagBindingsClient.create()) {
ResourceName parent = FolderName.of("[FOLDER]");
for (TagBinding element : tagBindingsClient.listTagBindings(parent).iterateAll()) {
// doThingsWith(element);
}
}
======================= TagHoldsClient =======================
Service Description: Allow users to create and manage TagHolds for TagValues. TagHolds represent the use of a Tag Value that is not captured by TagBindings but should still block TagValue deletion (such as a reference in a policy condition). This service provides isolated failure domains by cloud location so that TagHolds can be managed in the same location as their usage.
Sample for TagHoldsClient:
// 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 (TagHoldsClient tagHoldsClient = TagHoldsClient.create()) {
TagValueName parent = TagValueName.of("[TAG_VALUE]");
TagHold tagHold = TagHold.newBuilder().build();
TagHold response = tagHoldsClient.createTagHoldAsync(parent, tagHold).get();
}
======================= TagKeysClient =======================
Service Description: Allow users to create and manage tag keys.
Sample for TagKeysClient:
// 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 (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 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 (TagValuesClient tagValuesClient = TagValuesClient.create()) {
TagValueName name = TagValueName.of("[TAG_VALUE]");
TagValue response = tagValuesClient.getTagValue(name);
}
-
Class Summary Class Description CreateFolderMetadata Metadata pertaining to the Folder creation process.CreateFolderMetadata.Builder Metadata pertaining to the Folder creation process.CreateFolderRequest The CreateFolder request message.CreateFolderRequest.Builder The CreateFolder request message.CreateProjectMetadata A status object which is used as the `metadata` field for the Operation returned by CreateProject.CreateProjectMetadata.Builder A status object which is used as the `metadata` field for the Operation returned by CreateProject.CreateProjectRequest The request sent to the [CreateProject][google.cloud.resourcemanager.v3.Projects.CreateProject] method.CreateProjectRequest.Builder The request sent to the [CreateProject][google.cloud.resourcemanager.v3.Projects.CreateProject] method.CreateTagBindingMetadata Runtime operation information for creating a TagValue.CreateTagBindingMetadata.Builder Runtime operation information for creating a TagValue.CreateTagBindingRequest The request message to create a TagBinding.CreateTagBindingRequest.Builder The request message to create a TagBinding.CreateTagHoldMetadata Runtime operation information for creating a TagHold.CreateTagHoldMetadata.Builder Runtime operation information for creating a TagHold.CreateTagHoldRequest The request message to create a TagHold.CreateTagHoldRequest.Builder The request message to create a TagHold.CreateTagKeyMetadata Runtime operation information for creating a TagKey.CreateTagKeyMetadata.Builder Runtime operation information for creating a TagKey.CreateTagKeyRequest The request message for creating a TagKey.CreateTagKeyRequest.Builder The request message for creating a TagKey.CreateTagValueMetadata Runtime operation information for creating a TagValue.CreateTagValueMetadata.Builder Runtime operation information for creating a TagValue.CreateTagValueRequest The request message for creating a TagValue.CreateTagValueRequest.Builder The request message for creating a TagValue.DeleteFolderMetadata A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.DeleteFolderMetadata.Builder A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.DeleteFolderRequest The DeleteFolder request message.DeleteFolderRequest.Builder The DeleteFolder request message.DeleteOrganizationMetadata A status object which is used as the `metadata` field for the operation returned by DeleteOrganization.DeleteOrganizationMetadata.Builder A status object which is used as the `metadata` field for the operation returned by DeleteOrganization.DeleteProjectMetadata A status object which is used as the `metadata` field for the Operation returned by `DeleteProject`.DeleteProjectMetadata.Builder A status object which is used as the `metadata` field for the Operation returned by `DeleteProject`.DeleteProjectRequest [DeleteProject][google.cloud.resourcemanager.v3.Projects.DeleteProject] method.DeleteProjectRequest.Builder [DeleteProject][google.cloud.resourcemanager.v3.Projects.DeleteProject] method.DeleteTagBindingMetadata Runtime operation information for deleting a TagBinding.DeleteTagBindingMetadata.Builder Runtime operation information for deleting a TagBinding.DeleteTagBindingRequest The request message to delete a TagBinding.DeleteTagBindingRequest.Builder The request message to delete a TagBinding.DeleteTagHoldMetadata Runtime operation information for deleting a TagHold.DeleteTagHoldMetadata.Builder Runtime operation information for deleting a TagHold.DeleteTagHoldRequest The request message to delete a TagHold.DeleteTagHoldRequest.Builder The request message to delete a TagHold.DeleteTagKeyMetadata Runtime operation information for deleting a TagKey.DeleteTagKeyMetadata.Builder Runtime operation information for deleting a TagKey.DeleteTagKeyRequest The request message for deleting a TagKey.DeleteTagKeyRequest.Builder The request message for deleting a TagKey.DeleteTagValueMetadata Runtime operation information for deleting a TagValue.DeleteTagValueMetadata.Builder Runtime operation information for deleting a TagValue.DeleteTagValueRequest The request message for deleting a TagValue.DeleteTagValueRequest.Builder The request message for deleting a TagValue.EffectiveTag An EffectiveTag represents a tag that applies to a resource during policy evaluation.EffectiveTag.Builder An EffectiveTag represents a tag that applies to a resource during policy evaluation.Folder A folder in an organization's resource hierarchy, used to organize that organization's resources.Folder.Builder A folder in an organization's resource hierarchy, used to organize that organization's resources.FolderName FolderName.Builder Builder for folders/{folder}.FoldersClient Service Description: Manages Cloud Platform folder resources.FoldersClient.ListFoldersFixedSizeCollection FoldersClient.ListFoldersPage FoldersClient.ListFoldersPagedResponse FoldersClient.SearchFoldersFixedSizeCollection FoldersClient.SearchFoldersPage FoldersClient.SearchFoldersPagedResponse FoldersGrpc Manages Cloud Platform folder resources.FoldersGrpc.FoldersBlockingStub A stub to allow clients to do synchronous rpc calls to service Folders.FoldersGrpc.FoldersFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service Folders.FoldersGrpc.FoldersImplBase Base class for the server implementation of the service Folders.FoldersGrpc.FoldersStub A stub to allow clients to do asynchronous rpc calls to service Folders.FoldersProto FoldersSettings Settings class to configure an instance ofFoldersClient
.FoldersSettings.Builder Builder for FoldersSettings.GetFolderRequest The GetFolder request message.GetFolderRequest.Builder The GetFolder request message.GetNamespacedTagKeyRequest The request message for getting a TagKey by its namespaced name.GetNamespacedTagKeyRequest.Builder The request message for getting a TagKey by its namespaced name.GetNamespacedTagValueRequest The request message for getting a TagValue by its namespaced name.GetNamespacedTagValueRequest.Builder The request message for getting a TagValue by its namespaced name.GetOrganizationRequest The request sent to the `GetOrganization` method.GetOrganizationRequest.Builder The request sent to the `GetOrganization` method.GetProjectRequest The request sent to the [GetProject][google.cloud.resourcemanager.v3.Projects.GetProject] method.GetProjectRequest.Builder The request sent to the [GetProject][google.cloud.resourcemanager.v3.Projects.GetProject] method.GetTagKeyRequest The request message for getting a TagKey.GetTagKeyRequest.Builder The request message for getting a TagKey.GetTagValueRequest The request message for getting a TagValue.GetTagValueRequest.Builder The request message for getting a TagValue.ListEffectiveTagsRequest The request message to ListEffectiveTagsListEffectiveTagsRequest.Builder The request message to ListEffectiveTagsListEffectiveTagsResponse The response of ListEffectiveTags.ListEffectiveTagsResponse.Builder The response of ListEffectiveTags.ListFoldersRequest The ListFolders request message.ListFoldersRequest.Builder The ListFolders request message.ListFoldersResponse The ListFolders response message.ListFoldersResponse.Builder The ListFolders response message.ListProjectsRequest The request sent to the [ListProjects][google.cloud.resourcemanager.v3.Projects.ListProjects] method.ListProjectsRequest.Builder The request sent to the [ListProjects][google.cloud.resourcemanager.v3.Projects.ListProjects] method.ListProjectsResponse A page of the response received from the [ListProjects][google.cloud.resourcemanager.v3.Projects.ListProjects] method.ListProjectsResponse.Builder A page of the response received from the [ListProjects][google.cloud.resourcemanager.v3.Projects.ListProjects] method.ListTagBindingsRequest The request message to list all TagBindings for a parent.ListTagBindingsRequest.Builder The request message to list all TagBindings for a parent.ListTagBindingsResponse The ListTagBindings response.ListTagBindingsResponse.Builder The ListTagBindings response.ListTagHoldsRequest The request message for listing the TagHolds under a TagValue.ListTagHoldsRequest.Builder The request message for listing the TagHolds under a TagValue.ListTagHoldsResponse The ListTagHolds response.ListTagHoldsResponse.Builder The ListTagHolds response.ListTagKeysRequest The request message for listing all TagKeys under a parent resource.ListTagKeysRequest.Builder The request message for listing all TagKeys under a parent resource.ListTagKeysResponse The ListTagKeys response message.ListTagKeysResponse.Builder The ListTagKeys response message.ListTagValuesRequest The request message for listing TagValues for the specified TagKey.ListTagValuesRequest.Builder The request message for listing TagValues for the specified TagKey.ListTagValuesResponse The ListTagValues response.ListTagValuesResponse.Builder The ListTagValues response.MoveFolderMetadata Metadata pertaining to the folder move process.MoveFolderMetadata.Builder Metadata pertaining to the folder move process.MoveFolderRequest The MoveFolder request message.MoveFolderRequest.Builder The MoveFolder request message.MoveProjectMetadata A status object which is used as the `metadata` field for the Operation returned by MoveProject.MoveProjectMetadata.Builder A status object which is used as the `metadata` field for the Operation returned by MoveProject.MoveProjectRequest The request sent to [MoveProject][google.cloud.resourcemanager.v3.Projects.MoveProject] method.MoveProjectRequest.Builder The request sent to [MoveProject][google.cloud.resourcemanager.v3.Projects.MoveProject] method.Organization The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.Organization.Builder The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.OrganizationName OrganizationName.Builder Builder for organizations/{organization}.OrganizationsClient Service Description: Allows users to manage their organization resources.OrganizationsClient.SearchOrganizationsFixedSizeCollection OrganizationsClient.SearchOrganizationsPage OrganizationsClient.SearchOrganizationsPagedResponse OrganizationsGrpc Allows users to manage their organization resources.OrganizationsGrpc.OrganizationsBlockingStub A stub to allow clients to do synchronous rpc calls to service Organizations.OrganizationsGrpc.OrganizationsFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service Organizations.OrganizationsGrpc.OrganizationsImplBase Base class for the server implementation of the service Organizations.OrganizationsGrpc.OrganizationsStub A stub to allow clients to do asynchronous rpc calls to service Organizations.OrganizationsProto OrganizationsSettings Settings class to configure an instance ofOrganizationsClient
.OrganizationsSettings.Builder Builder for OrganizationsSettings.Project A project is a high-level Google Cloud entity.Project.Builder A project is a high-level Google Cloud entity.ProjectName ProjectName.Builder Builder for projects/{project}.ProjectsClient Service Description: Manages Google Cloud Projects.ProjectsClient.ListProjectsFixedSizeCollection ProjectsClient.ListProjectsPage ProjectsClient.ListProjectsPagedResponse ProjectsClient.SearchProjectsFixedSizeCollection ProjectsClient.SearchProjectsPage ProjectsClient.SearchProjectsPagedResponse ProjectsGrpc Manages Google Cloud Projects.ProjectsGrpc.ProjectsBlockingStub A stub to allow clients to do synchronous rpc calls to service Projects.ProjectsGrpc.ProjectsFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service Projects.ProjectsGrpc.ProjectsImplBase Base class for the server implementation of the service Projects.ProjectsGrpc.ProjectsStub A stub to allow clients to do asynchronous rpc calls to service Projects.ProjectsProto ProjectsSettings Settings class to configure an instance ofProjectsClient
.ProjectsSettings.Builder Builder for ProjectsSettings.SearchFoldersRequest The request message for searching folders.SearchFoldersRequest.Builder The request message for searching folders.SearchFoldersResponse The response message for searching folders.SearchFoldersResponse.Builder The response message for searching folders.SearchOrganizationsRequest The request sent to the `SearchOrganizations` method.SearchOrganizationsRequest.Builder The request sent to the `SearchOrganizations` method.SearchOrganizationsResponse The response returned from the `SearchOrganizations` method.SearchOrganizationsResponse.Builder The response returned from the `SearchOrganizations` method.SearchProjectsRequest The request sent to the [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects] method.SearchProjectsRequest.Builder The request sent to the [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects] method.SearchProjectsResponse A page of the response received from the [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects] method.SearchProjectsResponse.Builder A page of the response received from the [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects] method.TagBinding A TagBinding represents a connection between a TagValue and a cloud resource Once a TagBinding is created, the TagValue is applied to all the descendants of the Google Cloud resource.TagBinding.Builder A TagBinding represents a connection between a TagValue and a cloud resource Once a TagBinding is created, the TagValue is applied to all the descendants of the Google Cloud resource.TagBindingName TagBindingName.Builder Builder for tagBindings/{tag_binding}.TagBindingsClient Service Description: Allow users to create and manage TagBindings between TagValues and different Google Cloud resources throughout the GCP resource hierarchy.TagBindingsClient.ListEffectiveTagsFixedSizeCollection TagBindingsClient.ListEffectiveTagsPage TagBindingsClient.ListEffectiveTagsPagedResponse TagBindingsClient.ListTagBindingsFixedSizeCollection TagBindingsClient.ListTagBindingsPage TagBindingsClient.ListTagBindingsPagedResponse TagBindingsGrpc Allow users to create and manage TagBindings between TagValues and different Google Cloud resources throughout the GCP resource hierarchy.TagBindingsGrpc.TagBindingsBlockingStub A stub to allow clients to do synchronous rpc calls to service TagBindings.TagBindingsGrpc.TagBindingsFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service TagBindings.TagBindingsGrpc.TagBindingsImplBase Base class for the server implementation of the service TagBindings.TagBindingsGrpc.TagBindingsStub A stub to allow clients to do asynchronous rpc calls to service TagBindings.TagBindingsProto TagBindingsSettings Settings class to configure an instance ofTagBindingsClient
.TagBindingsSettings.Builder Builder for TagBindingsSettings.TagHold A TagHold represents the use of a TagValue that is not captured by TagBindings.TagHold.Builder A TagHold represents the use of a TagValue that is not captured by TagBindings.TagHoldName TagHoldName.Builder Builder for tagValues/{tag_value}/tagHolds/{tag_hold}.TagHoldsClient Service Description: Allow users to create and manage TagHolds for TagValues.TagHoldsClient.ListTagHoldsFixedSizeCollection TagHoldsClient.ListTagHoldsPage TagHoldsClient.ListTagHoldsPagedResponse TagHoldsGrpc Allow users to create and manage TagHolds for TagValues.TagHoldsGrpc.TagHoldsBlockingStub A stub to allow clients to do synchronous rpc calls to service TagHolds.TagHoldsGrpc.TagHoldsFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service TagHolds.TagHoldsGrpc.TagHoldsImplBase Base class for the server implementation of the service TagHolds.TagHoldsGrpc.TagHoldsStub A stub to allow clients to do asynchronous rpc calls to service TagHolds.TagHoldsProto TagHoldsSettings Settings class to configure an instance ofTagHoldsClient
.TagHoldsSettings.Builder Builder for TagHoldsSettings.TagKey A TagKey, used to group a set of TagValues.TagKey.Builder A TagKey, used to group a set of TagValues.TagKeyName TagKeyName.Builder Builder for tagKeys/{tag_key}.TagKeysClient Service Description: Allow users to create and manage tag keys.TagKeysClient.ListTagKeysFixedSizeCollection TagKeysClient.ListTagKeysPage TagKeysClient.ListTagKeysPagedResponse TagKeysGrpc Allow users to create and manage tag keys.TagKeysGrpc.TagKeysBlockingStub A stub to allow clients to do synchronous rpc calls to service TagKeys.TagKeysGrpc.TagKeysFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service TagKeys.TagKeysGrpc.TagKeysImplBase Base class for the server implementation of the service TagKeys.TagKeysGrpc.TagKeysStub A stub to allow clients to do asynchronous rpc calls to service TagKeys.TagKeysProto TagKeysSettings Settings class to configure an instance ofTagKeysClient
.TagKeysSettings.Builder Builder for TagKeysSettings.TagValue A TagValue is a child of a particular TagKey.TagValue.Builder A TagValue is a child of a particular TagKey.TagValueName TagValueName.Builder Builder for tagValues/{tag_value}.TagValuesClient Service Description: Allow users to create and manage tag values.TagValuesClient.ListTagValuesFixedSizeCollection TagValuesClient.ListTagValuesPage TagValuesClient.ListTagValuesPagedResponse TagValuesGrpc Allow users to create and manage tag values.TagValuesGrpc.TagValuesBlockingStub A stub to allow clients to do synchronous rpc calls to service TagValues.TagValuesGrpc.TagValuesFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service TagValues.TagValuesGrpc.TagValuesImplBase Base class for the server implementation of the service TagValues.TagValuesGrpc.TagValuesStub A stub to allow clients to do asynchronous rpc calls to service TagValues.TagValuesProto TagValuesSettings Settings class to configure an instance ofTagValuesClient
.TagValuesSettings.Builder Builder for TagValuesSettings.UndeleteFolderMetadata A status object which is used as the `metadata` field for the `Operation` returned by `UndeleteFolder`.UndeleteFolderMetadata.Builder A status object which is used as the `metadata` field for the `Operation` returned by `UndeleteFolder`.UndeleteFolderRequest The UndeleteFolder request message.UndeleteFolderRequest.Builder The UndeleteFolder request message.UndeleteOrganizationMetadata A status object which is used as the `metadata` field for the Operation returned by UndeleteOrganization.UndeleteOrganizationMetadata.Builder A status object which is used as the `metadata` field for the Operation returned by UndeleteOrganization.UndeleteProjectMetadata A status object which is used as the `metadata` field for the Operation returned by `UndeleteProject`.UndeleteProjectMetadata.Builder A status object which is used as the `metadata` field for the Operation returned by `UndeleteProject`.UndeleteProjectRequest The request sent to the [UndeleteProject] [google.cloud.resourcemanager.v3.Projects.UndeleteProject] method.UndeleteProjectRequest.Builder The request sent to the [UndeleteProject] [google.cloud.resourcemanager.v3.Projects.UndeleteProject] method.UpdateFolderMetadata A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.UpdateFolderMetadata.Builder A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.UpdateFolderRequest The request sent to the [UpdateFolder][google.cloud.resourcemanager.v3.Folder.UpdateFolder] method.UpdateFolderRequest.Builder The request sent to the [UpdateFolder][google.cloud.resourcemanager.v3.Folder.UpdateFolder] method.UpdateProjectMetadata A status object which is used as the `metadata` field for the Operation returned by UpdateProject.UpdateProjectMetadata.Builder A status object which is used as the `metadata` field for the Operation returned by UpdateProject.UpdateProjectRequest The request sent to the [UpdateProject][google.cloud.resourcemanager.v3.Projects.UpdateProject] method.UpdateProjectRequest.Builder The request sent to the [UpdateProject][google.cloud.resourcemanager.v3.Projects.UpdateProject] method.UpdateTagKeyMetadata Runtime operation information for updating a TagKey.UpdateTagKeyMetadata.Builder Runtime operation information for updating a TagKey.UpdateTagKeyRequest The request message for updating a TagKey.UpdateTagKeyRequest.Builder The request message for updating a TagKey.UpdateTagValueMetadata Runtime operation information for updating a TagValue.UpdateTagValueMetadata.Builder Runtime operation information for updating a TagValue.UpdateTagValueRequest The request message for updating a TagValue.UpdateTagValueRequest.Builder The request message for updating a TagValue. -
Enum Summary Enum Description Folder.State Folder lifecycle states.Organization.OwnerCase Organization.State Organization lifecycle states.Project.State Project lifecycle states.Purpose A purpose for each policy engine requiring such an integration.