Module api

Source

Structs§

FolderConstraintListCall
Lists constraints that could be applied on the specified resource.
FolderMethods
A builder providing access to all methods supported on folder resources. It is not used directly, but through the OrgPolicyAPI hub.
FolderPolicyCreateCall
Creates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the policy already exists on the given Google Cloud resource.
FolderPolicyDeleteCall
Deletes a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or organization policy does not exist.
FolderPolicyGetCall
Gets a policy on a resource. If no policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a policy during read-modify-write.
FolderPolicyGetEffectivePolicyCall
Gets the effective policy on a resource. This is the result of merging policies in the resource hierarchy and evaluating conditions. The returned policy will not have an etag or condition set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with ‘under:’ prefix will not be expanded.
FolderPolicyListCall
Retrieves all of the policies that exist on a particular resource.
FolderPolicyPatchCall
Updates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or the policy do not exist. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields.
GoogleCloudOrgpolicyV2AlternatePolicySpec
Similar to PolicySpec but with an extra ‘launch’ field for launch reference. The PolicySpec here is specific for dry-run/darklaunch.
GoogleCloudOrgpolicyV2Constraint
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 instance can have serial port connections established. Constraints can be configured by the organization policy administrator to fit the needs of the organization by setting a policy that includes constraints at different locations in the organization’s resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about policies. Constraints have a default behavior determined by the constraint_default field, which is the enforcement behavior that is used in the absence of a policy being defined or inherited for the resource in question.
GoogleCloudOrgpolicyV2ConstraintBooleanConstraint
A constraint that is either enforced or not. For example, a constraint constraints/compute.disableSerialPortAccess. If it is enforced on a VM instance, serial port connections will not be opened to that instance.
GoogleCloudOrgpolicyV2ConstraintListConstraint
A constraint that allows or disallows a list of string values, which are configured by an Organization Policy administrator with a policy.
GoogleCloudOrgpolicyV2CustomConstraint
A custom constraint defined by customers which can only be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. Creating a custom constraint itself does NOT apply any policy enforcement.
GoogleCloudOrgpolicyV2ListConstraintsResponse
The response returned from the ListConstraints method.
GoogleCloudOrgpolicyV2ListCustomConstraintsResponse
The response returned from the ListCustomConstraints method. It will be empty if no custom constraints are set on the organization resource.
GoogleCloudOrgpolicyV2ListPoliciesResponse
The response returned from the ListPolicies method. It will be empty if no policies are set on the resource.
GoogleCloudOrgpolicyV2Policy
Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.
GoogleCloudOrgpolicyV2PolicySpec
Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources.
GoogleCloudOrgpolicyV2PolicySpecPolicyRule
A rule used to express this policy.
GoogleCloudOrgpolicyV2PolicySpecPolicyRuleStringValues
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 are allowed or denied. This is achieved by using the under: and optional is: prefixes. The under: prefix is used to denote resource subtree values. The is: prefix is used to denote specific values, and is required only if the value contains a “:”. Values prefixed with “is:” are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - projects/ (for example, projects/tokyo-rain-123) - folders/ (for example, folders/1234) - organizations/ (for example, organizations/1234) The supports_under field of the associated Constraint defines whether ancestry prefixes can be used.
GoogleProtobufEmpty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
GoogleTypeExpr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: “Summary size limit” description: “Determines if a summary is less than 100 chars” expression: “document.summary.size() < 100” Example (Equality): title: “Requestor is owner” description: “Determines if requestor is the document owner” expression: “document.owner == request.auth.claims.email” Example (Logic): title: “Public documents” description: “Determine whether the document should be publicly visible” expression: “document.type != ‘private’ && document.type != ‘internal’” Example (Data Manipulation): title: “Notification string” description: “Create a notification string with a timestamp.” expression: “’New message received at ’ + string(document.create_time)” The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
OrgPolicyAPI
Central instance to access all OrgPolicyAPI related resource activities
OrganizationConstraintListCall
Lists constraints that could be applied on the specified resource.
OrganizationCustomConstraintCreateCall
Creates a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the organization does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the constraint already exists on the given organization.
OrganizationCustomConstraintDeleteCall
Deletes a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist.
OrganizationCustomConstraintGetCall
Gets a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the custom constraint does not exist.
OrganizationCustomConstraintListCall
Retrieves all of the custom constraints that exist on a particular organization resource.
OrganizationCustomConstraintPatchCall
Updates a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Note: the supplied policy will perform a full overwrite of all fields.
OrganizationMethods
A builder providing access to all methods supported on organization resources. It is not used directly, but through the OrgPolicyAPI hub.
OrganizationPolicyCreateCall
Creates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the policy already exists on the given Google Cloud resource.
OrganizationPolicyDeleteCall
Deletes a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or organization policy does not exist.
OrganizationPolicyGetCall
Gets a policy on a resource. If no policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a policy during read-modify-write.
OrganizationPolicyGetEffectivePolicyCall
Gets the effective policy on a resource. This is the result of merging policies in the resource hierarchy and evaluating conditions. The returned policy will not have an etag or condition set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with ‘under:’ prefix will not be expanded.
OrganizationPolicyListCall
Retrieves all of the policies that exist on a particular resource.
OrganizationPolicyPatchCall
Updates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or the policy do not exist. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields.
ProjectConstraintListCall
Lists constraints that could be applied on the specified resource.
ProjectMethods
A builder providing access to all methods supported on project resources. It is not used directly, but through the OrgPolicyAPI hub.
ProjectPolicyCreateCall
Creates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the policy already exists on the given Google Cloud resource.
ProjectPolicyDeleteCall
Deletes a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or organization policy does not exist.
ProjectPolicyGetCall
Gets a policy on a resource. If no policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a policy during read-modify-write.
ProjectPolicyGetEffectivePolicyCall
Gets the effective policy on a resource. This is the result of merging policies in the resource hierarchy and evaluating conditions. The returned policy will not have an etag or condition set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with ‘under:’ prefix will not be expanded.
ProjectPolicyListCall
Retrieves all of the policies that exist on a particular resource.
ProjectPolicyPatchCall
Updates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or the policy do not exist. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.