Package @google-cloud/org-policy (3.1.0)

Classes

protos.google.api.ClientLibrarySettings

Represents a ClientLibrarySettings.

protos.google.api.CommonLanguageSettings

Represents a CommonLanguageSettings.

protos.google.api.CppSettings

Represents a CppSettings.

protos.google.api.CustomHttpPattern

Represents a CustomHttpPattern.

protos.google.api.DotnetSettings

Represents a DotnetSettings.

protos.google.api.GoSettings

Represents a GoSettings.

protos.google.api.Http

Represents a Http.

protos.google.api.HttpRule

Represents a HttpRule.

protos.google.api.JavaSettings

Represents a JavaSettings.

protos.google.api.MethodSettings

Represents a MethodSettings.

protos.google.api.MethodSettings.LongRunning

Represents a LongRunning.

protos.google.api.NodeSettings

Represents a NodeSettings.

protos.google.api.PhpSettings

Represents a PhpSettings.

protos.google.api.Publishing

Represents a Publishing.

protos.google.api.PythonSettings

Represents a PythonSettings.

protos.google.api.ResourceDescriptor

Represents a ResourceDescriptor.

protos.google.api.ResourceReference

Represents a ResourceReference.

protos.google.api.RubySettings

Represents a RubySettings.

protos.google.cloud.orgpolicy.v2.AlternatePolicySpec

Represents an AlternatePolicySpec.

protos.google.cloud.orgpolicy.v2.Constraint

Represents a Constraint.

protos.google.cloud.orgpolicy.v2.Constraint.BooleanConstraint

Represents a BooleanConstraint.

protos.google.cloud.orgpolicy.v2.Constraint.ListConstraint

Represents a ListConstraint.

protos.google.cloud.orgpolicy.v2.CreateCustomConstraintRequest

Represents a CreateCustomConstraintRequest.

protos.google.cloud.orgpolicy.v2.CreatePolicyRequest

Represents a CreatePolicyRequest.

protos.google.cloud.orgpolicy.v2.CustomConstraint

Represents a CustomConstraint.

protos.google.cloud.orgpolicy.v2.DeleteCustomConstraintRequest

Represents a DeleteCustomConstraintRequest.

protos.google.cloud.orgpolicy.v2.DeletePolicyRequest

Represents a DeletePolicyRequest.

protos.google.cloud.orgpolicy.v2.GetCustomConstraintRequest

Represents a GetCustomConstraintRequest.

protos.google.cloud.orgpolicy.v2.GetEffectivePolicyRequest

Represents a GetEffectivePolicyRequest.

protos.google.cloud.orgpolicy.v2.GetPolicyRequest

Represents a GetPolicyRequest.

protos.google.cloud.orgpolicy.v2.ListConstraintsRequest

Represents a ListConstraintsRequest.

protos.google.cloud.orgpolicy.v2.ListConstraintsResponse

Represents a ListConstraintsResponse.

protos.google.cloud.orgpolicy.v2.ListCustomConstraintsRequest

Represents a ListCustomConstraintsRequest.

protos.google.cloud.orgpolicy.v2.ListCustomConstraintsResponse

Represents a ListCustomConstraintsResponse.

protos.google.cloud.orgpolicy.v2.ListPoliciesRequest

Represents a ListPoliciesRequest.

protos.google.cloud.orgpolicy.v2.ListPoliciesResponse

Represents a ListPoliciesResponse.

protos.google.cloud.orgpolicy.v2.OrgPolicy

Represents an OrgPolicy

protos.google.cloud.orgpolicy.v2.Policy

Represents a Policy.

protos.google.cloud.orgpolicy.v2.PolicySpec

Represents a PolicySpec.

protos.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule

Represents a PolicyRule.

protos.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule.StringValues

Represents a StringValues.

protos.google.cloud.orgpolicy.v2.UpdateCustomConstraintRequest

Represents an UpdateCustomConstraintRequest.

protos.google.cloud.orgpolicy.v2.UpdatePolicyRequest

Represents an UpdatePolicyRequest.

protos.google.protobuf.DescriptorProto

Represents a DescriptorProto.

protos.google.protobuf.DescriptorProto.ExtensionRange

Represents an ExtensionRange.

protos.google.protobuf.DescriptorProto.ReservedRange

Represents a ReservedRange.

protos.google.protobuf.Duration

Represents a Duration.

protos.google.protobuf.Empty

Represents an Empty.

protos.google.protobuf.EnumDescriptorProto

Represents an EnumDescriptorProto.

protos.google.protobuf.EnumDescriptorProto.EnumReservedRange

Represents an EnumReservedRange.

protos.google.protobuf.EnumOptions

Represents an EnumOptions.

protos.google.protobuf.EnumValueDescriptorProto

Represents an EnumValueDescriptorProto.

protos.google.protobuf.EnumValueOptions

Represents an EnumValueOptions.

protos.google.protobuf.ExtensionRangeOptions

Represents an ExtensionRangeOptions.

protos.google.protobuf.FieldDescriptorProto

Represents a FieldDescriptorProto.

protos.google.protobuf.FieldMask

Represents a FieldMask.

protos.google.protobuf.FieldOptions

Represents a FieldOptions.

protos.google.protobuf.FileDescriptorProto

Represents a FileDescriptorProto.

protos.google.protobuf.FileDescriptorSet

Represents a FileDescriptorSet.

protos.google.protobuf.FileOptions

Represents a FileOptions.

protos.google.protobuf.GeneratedCodeInfo

Represents a GeneratedCodeInfo.

protos.google.protobuf.GeneratedCodeInfo.Annotation

Represents an Annotation.

protos.google.protobuf.MessageOptions

Represents a MessageOptions.

protos.google.protobuf.MethodDescriptorProto

Represents a MethodDescriptorProto.

protos.google.protobuf.MethodOptions

Represents a MethodOptions.

protos.google.protobuf.OneofDescriptorProto

Represents an OneofDescriptorProto.

protos.google.protobuf.OneofOptions

Represents an OneofOptions.

protos.google.protobuf.ServiceDescriptorProto

Represents a ServiceDescriptorProto.

protos.google.protobuf.ServiceOptions

Represents a ServiceOptions.

protos.google.protobuf.SourceCodeInfo

Represents a SourceCodeInfo.

protos.google.protobuf.SourceCodeInfo.Location

Represents a Location.

protos.google.protobuf.Timestamp

Represents a Timestamp.

protos.google.protobuf.UninterpretedOption

Represents an UninterpretedOption.

protos.google.protobuf.UninterpretedOption.NamePart

Represents a NamePart.

protos.google.type.Expr

Represents an Expr.

v2.OrgPolicyClient

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.

You can use a policy to configure restrictions on resources. For example, you can enforce a policy that restricts which Google Cloud 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. v2

Interfaces

protos.google.api.IClientLibrarySettings

Properties of a ClientLibrarySettings.

protos.google.api.ICommonLanguageSettings

Properties of a CommonLanguageSettings.

protos.google.api.ICppSettings

Properties of a CppSettings.

protos.google.api.ICustomHttpPattern

Properties of a CustomHttpPattern.

protos.google.api.IDotnetSettings

Properties of a DotnetSettings.

protos.google.api.IGoSettings

Properties of a GoSettings.

protos.google.api.IHttp

Properties of a Http.

protos.google.api.IHttpRule

Properties of a HttpRule.

protos.google.api.IJavaSettings

Properties of a JavaSettings.

protos.google.api.IMethodSettings

Properties of a MethodSettings.

protos.google.api.INodeSettings

Properties of a NodeSettings.

protos.google.api.IPhpSettings

Properties of a PhpSettings.

protos.google.api.IPublishing

Properties of a Publishing.

protos.google.api.IPythonSettings

Properties of a PythonSettings.

protos.google.api.IResourceDescriptor

Properties of a ResourceDescriptor.

protos.google.api.IResourceReference

Properties of a ResourceReference.

protos.google.api.IRubySettings

Properties of a RubySettings.

protos.google.api.MethodSettings.ILongRunning

Properties of a LongRunning.

protos.google.cloud.orgpolicy.v2.Constraint.IBooleanConstraint

Properties of a BooleanConstraint.

protos.google.cloud.orgpolicy.v2.Constraint.IListConstraint

Properties of a ListConstraint.

protos.google.cloud.orgpolicy.v2.IAlternatePolicySpec

Properties of an AlternatePolicySpec.

protos.google.cloud.orgpolicy.v2.IConstraint

Properties of a Constraint.

protos.google.cloud.orgpolicy.v2.ICreateCustomConstraintRequest

Properties of a CreateCustomConstraintRequest.

protos.google.cloud.orgpolicy.v2.ICreatePolicyRequest

Properties of a CreatePolicyRequest.

protos.google.cloud.orgpolicy.v2.ICustomConstraint

Properties of a CustomConstraint.

protos.google.cloud.orgpolicy.v2.IDeleteCustomConstraintRequest

Properties of a DeleteCustomConstraintRequest.

protos.google.cloud.orgpolicy.v2.IDeletePolicyRequest

Properties of a DeletePolicyRequest.

protos.google.cloud.orgpolicy.v2.IGetCustomConstraintRequest

Properties of a GetCustomConstraintRequest.

protos.google.cloud.orgpolicy.v2.IGetEffectivePolicyRequest

Properties of a GetEffectivePolicyRequest.

protos.google.cloud.orgpolicy.v2.IGetPolicyRequest

Properties of a GetPolicyRequest.

protos.google.cloud.orgpolicy.v2.IListConstraintsRequest

Properties of a ListConstraintsRequest.

protos.google.cloud.orgpolicy.v2.IListConstraintsResponse

Properties of a ListConstraintsResponse.

protos.google.cloud.orgpolicy.v2.IListCustomConstraintsRequest

Properties of a ListCustomConstraintsRequest.

protos.google.cloud.orgpolicy.v2.IListCustomConstraintsResponse

Properties of a ListCustomConstraintsResponse.

protos.google.cloud.orgpolicy.v2.IListPoliciesRequest

Properties of a ListPoliciesRequest.

protos.google.cloud.orgpolicy.v2.IListPoliciesResponse

Properties of a ListPoliciesResponse.

protos.google.cloud.orgpolicy.v2.IPolicy

Properties of a Policy.

protos.google.cloud.orgpolicy.v2.IPolicySpec

Properties of a PolicySpec.

protos.google.cloud.orgpolicy.v2.IUpdateCustomConstraintRequest

Properties of an UpdateCustomConstraintRequest.

protos.google.cloud.orgpolicy.v2.IUpdatePolicyRequest

Properties of an UpdatePolicyRequest.

protos.google.cloud.orgpolicy.v2.PolicySpec.IPolicyRule

Properties of a PolicyRule.

protos.google.cloud.orgpolicy.v2.PolicySpec.PolicyRule.IStringValues

Properties of a StringValues.

protos.google.protobuf.DescriptorProto.IExtensionRange

Properties of an ExtensionRange.

protos.google.protobuf.DescriptorProto.IReservedRange

Properties of a ReservedRange.

protos.google.protobuf.EnumDescriptorProto.IEnumReservedRange

Properties of an EnumReservedRange.

protos.google.protobuf.GeneratedCodeInfo.IAnnotation

Properties of an Annotation.

protos.google.protobuf.IDescriptorProto

Properties of a DescriptorProto.

protos.google.protobuf.IDuration

Properties of a Duration.

protos.google.protobuf.IEmpty

Properties of an Empty.

protos.google.protobuf.IEnumDescriptorProto

Properties of an EnumDescriptorProto.

protos.google.protobuf.IEnumOptions

Properties of an EnumOptions.

protos.google.protobuf.IEnumValueDescriptorProto

Properties of an EnumValueDescriptorProto.

protos.google.protobuf.IEnumValueOptions

Properties of an EnumValueOptions.

protos.google.protobuf.IExtensionRangeOptions

Properties of an ExtensionRangeOptions.

protos.google.protobuf.IFieldDescriptorProto

Properties of a FieldDescriptorProto.

protos.google.protobuf.IFieldMask

Properties of a FieldMask.

protos.google.protobuf.IFieldOptions

Properties of a FieldOptions.

protos.google.protobuf.IFileDescriptorProto

Properties of a FileDescriptorProto.

protos.google.protobuf.IFileDescriptorSet

Properties of a FileDescriptorSet.

protos.google.protobuf.IFileOptions

Properties of a FileOptions.

protos.google.protobuf.IGeneratedCodeInfo

Properties of a GeneratedCodeInfo.

protos.google.protobuf.IMessageOptions

Properties of a MessageOptions.

protos.google.protobuf.IMethodDescriptorProto

Properties of a MethodDescriptorProto.

protos.google.protobuf.IMethodOptions

Properties of a MethodOptions.

protos.google.protobuf.IOneofDescriptorProto

Properties of an OneofDescriptorProto.

protos.google.protobuf.IOneofOptions

Properties of an OneofOptions.

protos.google.protobuf.IServiceDescriptorProto

Properties of a ServiceDescriptorProto.

protos.google.protobuf.IServiceOptions

Properties of a ServiceOptions.

protos.google.protobuf.ISourceCodeInfo

Properties of a SourceCodeInfo.

protos.google.protobuf.ITimestamp

Properties of a Timestamp.

protos.google.protobuf.IUninterpretedOption

Properties of an UninterpretedOption.

protos.google.protobuf.SourceCodeInfo.ILocation

Properties of a Location.

protos.google.protobuf.UninterpretedOption.INamePart

Properties of a NamePart.

protos.google.type.IExpr

Properties of an Expr.

Enums

protos.google.api.ClientLibraryDestination

ClientLibraryDestination enum.

protos.google.api.ClientLibraryOrganization

ClientLibraryOrganization enum.

protos.google.api.FieldBehavior

FieldBehavior enum.

protos.google.api.LaunchStage

LaunchStage enum.

protos.google.api.ResourceDescriptor.History

History enum.

protos.google.api.ResourceDescriptor.Style

Style enum.

protos.google.cloud.orgpolicy.v2.Constraint.ConstraintDefault

ConstraintDefault enum.

protos.google.cloud.orgpolicy.v2.CustomConstraint.ActionType

ActionType enum.

protos.google.cloud.orgpolicy.v2.CustomConstraint.MethodType

MethodType enum.

protos.google.protobuf.FieldDescriptorProto.Label

Label enum.

protos.google.protobuf.FieldDescriptorProto.Type

Type enum.

protos.google.protobuf.FieldOptions.CType

CType enum.

protos.google.protobuf.FieldOptions.JSType

JSType enum.

protos.google.protobuf.FieldOptions.OptionRetention

OptionRetention enum.

protos.google.protobuf.FieldOptions.OptionTargetType

OptionTargetType enum.

protos.google.protobuf.FileOptions.OptimizeMode

OptimizeMode enum.

protos.google.protobuf.GeneratedCodeInfo.Annotation.Semantic

Semantic enum.

protos.google.protobuf.MethodOptions.IdempotencyLevel

IdempotencyLevel enum.

Variables

_default

_default: {
    v2: typeof v2;
    OrgPolicyClient: typeof v2.OrgPolicyClient;
}

OrgPolicyClient

OrgPolicyClient: typeof v2.OrgPolicyClient

Type Aliases

OrgPolicyClient

type OrgPolicyClient = v2.OrgPolicyClient;

protos.google.cloud.orgpolicy.v2.OrgPolicy.CreateCustomConstraintCallback

type CreateCustomConstraintCallback = (error: (Error|null), response?: google.cloud.orgpolicy.v2.CustomConstraint) => void;

Callback as used by .

protos.google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicyCallback

type CreatePolicyCallback = (error: (Error|null), response?: google.cloud.orgpolicy.v2.Policy) => void;

Callback as used by .

protos.google.cloud.orgpolicy.v2.OrgPolicy.DeleteCustomConstraintCallback

type DeleteCustomConstraintCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicyCallback

type DeletePolicyCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.cloud.orgpolicy.v2.OrgPolicy.GetCustomConstraintCallback

type GetCustomConstraintCallback = (error: (Error|null), response?: google.cloud.orgpolicy.v2.CustomConstraint) => void;

Callback as used by .

protos.google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicyCallback

type GetEffectivePolicyCallback = (error: (Error|null), response?: google.cloud.orgpolicy.v2.Policy) => void;

Callback as used by .

protos.google.cloud.orgpolicy.v2.OrgPolicy.GetPolicyCallback

type GetPolicyCallback = (error: (Error|null), response?: google.cloud.orgpolicy.v2.Policy) => void;

Callback as used by .

protos.google.cloud.orgpolicy.v2.OrgPolicy.ListConstraintsCallback

type ListConstraintsCallback = (error: (Error|null), response?: google.cloud.orgpolicy.v2.ListConstraintsResponse) => void;

Callback as used by .

protos.google.cloud.orgpolicy.v2.OrgPolicy.ListCustomConstraintsCallback

type ListCustomConstraintsCallback = (error: (Error|null), response?: google.cloud.orgpolicy.v2.ListCustomConstraintsResponse) => void;

Callback as used by .

protos.google.cloud.orgpolicy.v2.OrgPolicy.ListPoliciesCallback

type ListPoliciesCallback = (error: (Error|null), response?: google.cloud.orgpolicy.v2.ListPoliciesResponse) => void;

Callback as used by .

protos.google.cloud.orgpolicy.v2.OrgPolicy.UpdateCustomConstraintCallback

type UpdateCustomConstraintCallback = (error: (Error|null), response?: google.cloud.orgpolicy.v2.CustomConstraint) => void;

Callback as used by .

protos.google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicyCallback

type UpdatePolicyCallback = (error: (Error|null), response?: google.cloud.orgpolicy.v2.Policy) => void;

Callback as used by .