| 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. |
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. |
Settings class to configure an instance of OrgPolicyClient.
The default instance has everything set to sensible defaults: |
Classes
| Class | Description |
|---|---|
| com. |
Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run. |
| com. |
Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run. |
| com. |
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. |
A constraint type is enforced or not enforced, which is configured in the
PolicyRule.
|
| com. |
A constraint type is enforced or not enforced, which is configured in the
PolicyRule.
|
| com. |
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. |
Custom constraint definition. Defines this as a managed constraint. |
| com. |
Custom constraint definition. Defines this as a managed constraint. |
| com. |
Defines a parameter structure. |
| com. |
Defines a parameter structure. |
| com. |
Defines Metadata structure. |
| com. |
Defines Metadata structure. |
| com. |
A constraint type that allows or disallows a list of string values, which
are configured in the
PolicyRule. |
| com. |
A constraint type that allows or disallows a list of string values, which
are configured in the
PolicyRule. |
| com. |
|
| com. |
Builder for projects/{project}/constraints/{constraint}. |
| com. |
Builder for folders/{folder}/constraints/{constraint}. |
| com. |
Builder for organizations/{organization}/constraints/{constraint}. |
| com. |
|
| com. |
The request sent to the [CreateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreateCustomConstraint] method. |
| com. |
The request sent to the [CreateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreateCustomConstraint] method. |
| com. |
The request sent to the [CreatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy] method. |
| com. |
The request sent to the [CreatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy] method. |
| com. |
A custom constraint defined by customers which can only be applied to the given resource types and organization. |
| com. |
A custom constraint defined by customers which can only be applied to the given resource types and organization. |
| com. |
|
| com. |
Builder for organizations/{organization}/customConstraints/{custom_constraint}. |
| com. |
The request sent to the [DeleteCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.DeleteCustomConstraint] method. |
| com. |
The request sent to the [DeleteCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.DeleteCustomConstraint] method. |
| com. |
The request sent to the [DeletePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy] method. |
| com. |
The request sent to the [DeletePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy] method. |
| com. |
|
| com. |
Builder for folders/{folder}. |
| com. |
The request sent to the [GetCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.GetCustomConstraint] method. |
| com. |
The request sent to the [GetCustomConstraint] [google.cloud.orgpolicy.v2.OrgPolicy.GetCustomConstraint] method. |
| com. |
The request sent to the [GetEffectivePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy] method. |
| com. |
The request sent to the [GetEffectivePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy] method. |
| com. |
The request sent to the [GetPolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetPolicy] method. |
| com. |
The request sent to the [GetPolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetPolicy] method. |
| com. |
The request sent to the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method. |
| com. |
The request sent to the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method. |
| com. |
The response returned from the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method. |
| com. |
The response returned from the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method. |
| com. |
The request sent to the [ListCustomConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method. |
| com. |
The request sent to the [ListCustomConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method. |
| com. |
The response returned from the [ListCustomConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method. It will be empty if no custom or managed constraints are set on the organization |
| com. |
The response returned from the [ListCustomConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraints] method. It will be empty if no custom or managed constraints are set on the organization |
| com. |
The request sent to the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method. |
| com. |
The request sent to the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method. |
| com. |
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. |
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. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
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. |
Base class for the server implementation of the service OrgPolicy. An interface for managing organization policies. |
| com. |
|
| com. |
Builder for OrgPolicySettings. |
| com. |
|
| com. |
Builder for organizations/{organization}. |
| com. |
Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources. |
| com. |
Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources. |
| com. |
|
| com. |
Builder for projects/{project}/policies/{policy}. |
| com. |
Builder for folders/{folder}/policies/{policy}. |
| com. |
Builder for organizations/{organization}/policies/{policy}. |
| com. |
Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources. |
| com. |
Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources. |
| com. |
A rule used to express this policy. |
| com. |
A rule used to express this policy. |
| com. |
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. |
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. |
|
| com. |
Builder for projects/{project}. |
| com. |
The request sent to the [UpdateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdateCustomConstraint] method. |
| com. |
The request sent to the [UpdateCustomConstraintRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdateCustomConstraint] method. |
| com. |
The request sent to the [UpdatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy] method. |
| com. |
The request sent to the [UpdatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy] method. |
Interfaces
Enums
| Enum | Description |
|---|---|
| com. |
Specifies the default behavior in the absence of any policy for the
constraint. This must not be CONSTRAINT_DEFAULT_UNSPECIFIED.
|
| com. |
|
| com. |
Allow or deny type. |
| com. |
The operation for which this constraint will be applied. To apply this
constraint only when creating new resources, the method_types should be
CREATE only. To apply this constraint when creating or deleting |
| com. |
All valid types of parameter. |
| com. |
Allow or deny type. |
| com. |
The operation for which this constraint will be applied. To apply this
constraint only when creating new resources, the method_types should be
CREATE only. To apply this constraint when creating or deleting |
| com. |