Package com.google.cloud.orgpolicy.v2 (2.48.0)

GitHub Repository

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.orgpolicy.v2.OrgPolicyClient Service Description: An interface for managing organization policies.

The Organization Policy Service provides a simple mechanism for organizations to restrict the allowed configurations across their entire resource hierarchy.

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.orgpolicy.v2.OrgPolicySettings Settings class to configure an instance of OrgPolicyClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.orgpolicy.v2.AlternatePolicySpec Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run/darklaunch.
com.google.cloud.orgpolicy.v2.AlternatePolicySpec.Builder Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run/darklaunch.
com.google.cloud.orgpolicy.v2.Constraint A constraint describes a way to restrict resource's configuration. For example, you could enforce a constraint that controls which Google Cloud services can be activated across an organization, or whether a Compute Engine
com.google.cloud.orgpolicy.v2.Constraint.BooleanConstraint A constraint that is either enforced or not. For example, a constraint constraints/compute.disableSerialPortAccess.
com.google.cloud.orgpolicy.v2.Constraint.BooleanConstraint.Builder A constraint that is either enforced or not. For example, a constraint constraints/compute.disableSerialPortAccess.
com.google.cloud.orgpolicy.v2.Constraint.Builder A constraint describes a way to restrict resource's configuration. For example, you could enforce a constraint that controls which Google Cloud services can be activated across an organization, or whether a Compute Engine
com.google.cloud.orgpolicy.v2.Constraint.ListConstraint A constraint that allows or disallows a list of string values, which are configured by an Organization Policy administrator with a policy.
com.google.cloud.orgpolicy.v2.Constraint.ListConstraint.Builder A constraint that allows or disallows a list of string values, which are configured by an Organization Policy administrator with a policy.
com.google.cloud.orgpolicy.v2.ConstraintName
com.google.cloud.orgpolicy.v2.ConstraintName.Builder Builder for projects/{project}/constraints/{constraint}.
com.google.cloud.orgpolicy.v2.ConstraintName.FolderConstraintBuilder Builder for folders/{folder}/constraints/{constraint}.
com.google.cloud.orgpolicy.v2.ConstraintName.OrganizationConstraintBuilder Builder for organizations/{organization}/constraints/{constraint}.
com.google.cloud.orgpolicy.v2.ConstraintProto
com.google.cloud.orgpolicy.v2.CreateCustomConstraintRequest The request sent to the [CreateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreateCustomConstraint] method.
com.google.cloud.orgpolicy.v2.CreateCustomConstraintRequest.Builder The request sent to the [CreateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreateCustomConstraint] method.
com.google.cloud.orgpolicy.v2.CreatePolicyRequest The request sent to the [CreatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy] method.
com.google.cloud.orgpolicy.v2.CreatePolicyRequest.Builder The request sent to the [CreatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy] method.
com.google.cloud.orgpolicy.v2.CustomConstraint A custom constraint defined by customers which can only be applied to the given resource types and organization.
com.google.cloud.orgpolicy.v2.CustomConstraint.Builder A custom constraint defined by customers which can only be applied to the given resource types and organization.
com.google.cloud.orgpolicy.v2.CustomConstraintName
com.google.cloud.orgpolicy.v2.CustomConstraintName.Builder Builder for organizations/{organization}/customConstraints/{custom_constraint}.
com.google.cloud.orgpolicy.v2.DeleteCustomConstraintRequest The request sent to the [DeleteCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.DeleteCustomConstraint] method.
com.google.cloud.orgpolicy.v2.DeleteCustomConstraintRequest.Builder The request sent to the [DeleteCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.DeleteCustomConstraint] method.
com.google.cloud.orgpolicy.v2.DeletePolicyRequest The request sent to the [DeletePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy] method.
com.google.cloud.orgpolicy.v2.DeletePolicyRequest.Builder The request sent to the [DeletePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy] method.
com.google.cloud.orgpolicy.v2.FolderName
com.google.cloud.orgpolicy.v2.FolderName.Builder Builder for folders/{folder}.
com.google.cloud.orgpolicy.v2.GetCustomConstraintRequest The request sent to the [GetCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.GetCustomConstraint] method.
com.google.cloud.orgpolicy.v2.GetCustomConstraintRequest.Builder The request sent to the [GetCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.GetCustomConstraint] method.
com.google.cloud.orgpolicy.v2.GetEffectivePolicyRequest The request sent to the [GetEffectivePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy] method.
com.google.cloud.orgpolicy.v2.GetEffectivePolicyRequest.Builder The request sent to the [GetEffectivePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy] method.
com.google.cloud.orgpolicy.v2.GetPolicyRequest The request sent to the [GetPolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetPolicy] method.
com.google.cloud.orgpolicy.v2.GetPolicyRequest.Builder The request sent to the [GetPolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetPolicy] method.
com.google.cloud.orgpolicy.v2.ListConstraintsRequest The request sent to the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.
com.google.cloud.orgpolicy.v2.ListConstraintsRequest.Builder The request sent to the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.
com.google.cloud.orgpolicy.v2.ListConstraintsResponse The response returned from the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.
com.google.cloud.orgpolicy.v2.ListConstraintsResponse.Builder The response returned from the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method.
com.google.cloud.orgpolicy.v2.ListCustomConstraintsRequest The request sent to the [ListCustomConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method.
com.google.cloud.orgpolicy.v2.ListCustomConstraintsRequest.Builder The request sent to the [ListCustomConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method.
com.google.cloud.orgpolicy.v2.ListCustomConstraintsResponse The response returned from the [ListCustomConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method. It will be empty if no custom constraints are set on the organization resource.
com.google.cloud.orgpolicy.v2.ListCustomConstraintsResponse.Builder The response returned from the [ListCustomConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method. It will be empty if no custom constraints are set on the organization resource.
com.google.cloud.orgpolicy.v2.ListPoliciesRequest The request sent to the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method.
com.google.cloud.orgpolicy.v2.ListPoliciesRequest.Builder The request sent to the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method.
com.google.cloud.orgpolicy.v2.ListPoliciesResponse The response returned from the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method. It will be empty if no policies are set on the resource.
com.google.cloud.orgpolicy.v2.ListPoliciesResponse.Builder The response returned from the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method. It will be empty if no policies are set on the resource.
com.google.cloud.orgpolicy.v2.OrgPolicyClient.ListConstraintsFixedSizeCollection
com.google.cloud.orgpolicy.v2.OrgPolicyClient.ListConstraintsPage
com.google.cloud.orgpolicy.v2.OrgPolicyClient.ListConstraintsPagedResponse
com.google.cloud.orgpolicy.v2.OrgPolicyClient.ListCustomConstraintsFixedSizeCollection
com.google.cloud.orgpolicy.v2.OrgPolicyClient.ListCustomConstraintsPage
com.google.cloud.orgpolicy.v2.OrgPolicyClient.ListCustomConstraintsPagedResponse
com.google.cloud.orgpolicy.v2.OrgPolicyClient.ListPoliciesFixedSizeCollection
com.google.cloud.orgpolicy.v2.OrgPolicyClient.ListPoliciesPage
com.google.cloud.orgpolicy.v2.OrgPolicyClient.ListPoliciesPagedResponse
com.google.cloud.orgpolicy.v2.OrgPolicyGrpc An interface for managing organization policies. The Organization Policy Service provides a simple mechanism for organizations to restrict the allowed configurations across their entire
com.google.cloud.orgpolicy.v2.OrgPolicyGrpc.OrgPolicyImplBase Base class for the server implementation of the service OrgPolicy. An interface for managing organization policies.
com.google.cloud.orgpolicy.v2.OrgPolicyProto
com.google.cloud.orgpolicy.v2.OrgPolicySettings.Builder Builder for OrgPolicySettings.
com.google.cloud.orgpolicy.v2.OrganizationName
com.google.cloud.orgpolicy.v2.OrganizationName.Builder Builder for organizations/{organization}.
com.google.cloud.orgpolicy.v2.Policy Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.
com.google.cloud.orgpolicy.v2.Policy.Builder Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.
com.google.cloud.orgpolicy.v2.PolicyName
com.google.cloud.orgpolicy.v2.PolicyName.Builder Builder for projects/{project}/policies/{policy}.
com.google.cloud.orgpolicy.v2.PolicyName.FolderPolicyBuilder Builder for folders/{folder}/policies/{policy}.
com.google.cloud.orgpolicy.v2.PolicyName.OrganizationPolicyBuilder Builder for organizations/{organization}/policies/{policy}.
com.google.cloud.orgpolicy.v2.PolicySpec Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources.
com.google.cloud.orgpolicy.v2.PolicySpec.Builder Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources.
com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule A rule used to express this policy.
com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule.Builder A rule used to express this policy.
com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule.StringValues A message that holds specific allowed and denied values. This message can define specific values and subtrees of the Resource Manager resource hierarchy (Organizations, Folders, Projects) that
com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule.StringValues.Builder A message that holds specific allowed and denied values. This message can define specific values and subtrees of the Resource Manager resource hierarchy (Organizations, Folders, Projects) that
com.google.cloud.orgpolicy.v2.ProjectName
com.google.cloud.orgpolicy.v2.ProjectName.Builder Builder for projects/{project}.
com.google.cloud.orgpolicy.v2.UpdateCustomConstraintRequest The request sent to the [UpdateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdateCustomConstraint] method.
com.google.cloud.orgpolicy.v2.UpdateCustomConstraintRequest.Builder The request sent to the [UpdateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdateCustomConstraint] method.
com.google.cloud.orgpolicy.v2.UpdatePolicyRequest The request sent to the [UpdatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy] method.
com.google.cloud.orgpolicy.v2.UpdatePolicyRequest.Builder The request sent to the [UpdatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy] method.

Interfaces

Interface Description
com.google.cloud.orgpolicy.v2.AlternatePolicySpecOrBuilder
com.google.cloud.orgpolicy.v2.Constraint.BooleanConstraintOrBuilder
com.google.cloud.orgpolicy.v2.Constraint.ListConstraintOrBuilder
com.google.cloud.orgpolicy.v2.ConstraintOrBuilder
com.google.cloud.orgpolicy.v2.CreateCustomConstraintRequestOrBuilder
com.google.cloud.orgpolicy.v2.CreatePolicyRequestOrBuilder
com.google.cloud.orgpolicy.v2.CustomConstraintOrBuilder
com.google.cloud.orgpolicy.v2.DeleteCustomConstraintRequestOrBuilder
com.google.cloud.orgpolicy.v2.DeletePolicyRequestOrBuilder
com.google.cloud.orgpolicy.v2.GetCustomConstraintRequestOrBuilder
com.google.cloud.orgpolicy.v2.GetEffectivePolicyRequestOrBuilder
com.google.cloud.orgpolicy.v2.GetPolicyRequestOrBuilder
com.google.cloud.orgpolicy.v2.ListConstraintsRequestOrBuilder
com.google.cloud.orgpolicy.v2.ListConstraintsResponseOrBuilder
com.google.cloud.orgpolicy.v2.ListCustomConstraintsRequestOrBuilder
com.google.cloud.orgpolicy.v2.ListCustomConstraintsResponseOrBuilder
com.google.cloud.orgpolicy.v2.ListPoliciesRequestOrBuilder
com.google.cloud.orgpolicy.v2.ListPoliciesResponseOrBuilder
com.google.cloud.orgpolicy.v2.OrgPolicyGrpc.AsyncService An interface for managing organization policies. The Organization Policy Service provides a simple mechanism for organizations to restrict the allowed configurations across their entire
com.google.cloud.orgpolicy.v2.PolicyOrBuilder
com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule.StringValuesOrBuilder
com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRuleOrBuilder
com.google.cloud.orgpolicy.v2.PolicySpecOrBuilder
com.google.cloud.orgpolicy.v2.UpdateCustomConstraintRequestOrBuilder
com.google.cloud.orgpolicy.v2.UpdatePolicyRequestOrBuilder

Enums

Enum Description
com.google.cloud.orgpolicy.v2.Constraint.ConstraintDefault Specifies the default behavior in the absence of any policy for the constraint. This must not be CONSTRAINT_DEFAULT_UNSPECIFIED.
com.google.cloud.orgpolicy.v2.Constraint.ConstraintTypeCase
com.google.cloud.orgpolicy.v2.CustomConstraint.ActionType Allow or deny type.
com.google.cloud.orgpolicy.v2.CustomConstraint.MethodType The operation for which this constraint will be applied. To apply this constraint only when creating new VMs, the method_types should be CREATE only. To apply this constraint when creating or deleting
com.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule.KindCase