@Generated("by gapic-generator-java")
Package com.google.cloud.orgpolicy.v2
The interfaces provided are listed below, along with usage samples.
======================= OrgPolicyClient =======================
Service Description: An interface for managing organization policies.
The Cloud Org Policy service provides a simple mechanism for organizations to restrict the allowed configurations across their entire Cloud Resource hierarchy.
You can use a `policy` to configure restrictions in Cloud resources. For example, you can enforce a `policy` that restricts which Google Cloud Platform APIs can be activated in a certain part of your resource hierarchy, or prevents serial port access to VM instances in a particular folder.
`Policies` are inherited down through the resource hierarchy. A `policy` applied to a parent resource automatically applies to all its child resources unless overridden with a `policy` lower in the hierarchy.
A `constraint` defines an aspect of a resource's configuration that can be controlled by an organization's policy administrator. `Policies` are a collection of `constraints` that defines their allowable configuration on a particular resource and its child resources.
Sample for OrgPolicyClient:
// 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 (OrgPolicyClient orgPolicyClient = OrgPolicyClient.create()) {
PolicyName name = PolicyName.ofProjectPolicyName("[PROJECT]", "[POLICY]");
Policy response = orgPolicyClient.getPolicy(name);
}
-
Class Summary Class Description AlternatePolicySpec Similar to PolicySpec but with an extra 'launch' field for launch reference.AlternatePolicySpec.Builder Similar to PolicySpec but with an extra 'launch' field for launch reference.Constraint A `constraint` describes a way to restrict resource's configuration.Constraint.BooleanConstraint A `Constraint` that is either enforced or not.Constraint.BooleanConstraint.Builder A `Constraint` that is either enforced or not.Constraint.Builder A `constraint` describes a way to restrict resource's configuration.Constraint.ListConstraint A `Constraint` that allows or disallows a list of string values, which are configured by an Organization's policy administrator with a `Policy`.Constraint.ListConstraint.Builder A `Constraint` that allows or disallows a list of string values, which are configured by an Organization's policy administrator with a `Policy`.ConstraintName ConstraintName.Builder Builder for projects/{project}/constraints/{constraint}.ConstraintName.FolderConstraintBuilder Builder for folders/{folder}/constraints/{constraint}.ConstraintName.OrganizationConstraintBuilder Builder for organizations/{organization}/constraints/{constraint}.ConstraintProto CreatePolicyRequest The request sent to the [CreatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy] method.CreatePolicyRequest.Builder The request sent to the [CreatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy] method.DeletePolicyRequest The request sent to the [DeletePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy] method.DeletePolicyRequest.Builder The request sent to the [DeletePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy] method.FolderName FolderName.Builder Builder for folders/{folder}.GetEffectivePolicyRequest The request sent to the [GetEffectivePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy] method.GetEffectivePolicyRequest.Builder The request sent to the [GetEffectivePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy] method.GetPolicyRequest The request sent to the [GetPolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetPolicy] method.GetPolicyRequest.Builder The request sent to the [GetPolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetPolicy] method.ListConstraintsRequest The request sent to the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.ListConstraintsRequest.Builder The request sent to the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.ListConstraintsResponse The response returned from the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.ListConstraintsResponse.Builder The response returned from the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.ListPoliciesRequest The request sent to the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method.ListPoliciesRequest.Builder The request sent to the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method.ListPoliciesResponse The response returned from the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method.ListPoliciesResponse.Builder The response returned from the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method.OrganizationName OrganizationName.Builder Builder for organizations/{organization}.OrgPolicyClient Service Description: An interface for managing organization policies.OrgPolicyClient.ListConstraintsFixedSizeCollection OrgPolicyClient.ListConstraintsPage OrgPolicyClient.ListConstraintsPagedResponse OrgPolicyClient.ListPoliciesFixedSizeCollection OrgPolicyClient.ListPoliciesPage OrgPolicyClient.ListPoliciesPagedResponse OrgPolicyGrpc An interface for managing organization policies.OrgPolicyGrpc.OrgPolicyBlockingStub A stub to allow clients to do synchronous rpc calls to service OrgPolicy.OrgPolicyGrpc.OrgPolicyFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service OrgPolicy.OrgPolicyGrpc.OrgPolicyImplBase Base class for the server implementation of the service OrgPolicy.OrgPolicyGrpc.OrgPolicyStub A stub to allow clients to do asynchronous rpc calls to service OrgPolicy.OrgPolicyProto OrgPolicySettings Settings class to configure an instance ofOrgPolicyClient
.OrgPolicySettings.Builder Builder for OrgPolicySettings.Policy Defines a Cloud Organization `Policy` which is used to specify `Constraints` for configurations of Cloud Platform resources.Policy.Builder Defines a Cloud Organization `Policy` which is used to specify `Constraints` for configurations of Cloud Platform resources.PolicyName PolicyName.Builder Builder for projects/{project}/policies/{policy}.PolicyName.FolderPolicyBuilder Builder for folders/{folder}/policies/{policy}.PolicyName.OrganizationPolicyBuilder Builder for organizations/{organization}/policies/{policy}.PolicySpec Defines a Cloud Organization `PolicySpec` which is used to specify `Constraints` for configurations of Cloud Platform resources.PolicySpec.Builder Defines a Cloud Organization `PolicySpec` which is used to specify `Constraints` for configurations of Cloud Platform resources.PolicySpec.PolicyRule A rule used to express this policy.PolicySpec.PolicyRule.Builder A rule used to express this policy.PolicySpec.PolicyRule.StringValues A message that holds specific allowed and denied values.PolicySpec.PolicyRule.StringValues.Builder A message that holds specific allowed and denied values.ProjectName ProjectName.Builder Builder for projects/{project}.UpdatePolicyRequest The request sent to the [UpdatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy] method.UpdatePolicyRequest.Builder The request sent to the [UpdatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy] method. -
Enum Summary Enum Description Constraint.ConstraintDefault Specifies the default behavior in the absence of any `Policy` for the `Constraint`.Constraint.ConstraintTypeCase PolicySpec.PolicyRule.KindCase