Class GoogleCloudOsconfigV2betaPolicyOrchestrator
PolicyOrchestrator helps managing project+zone level policy resources (e.g. OS Policy Assignments), by providing
tools to create, update and delete them across projects and locations, at scale. Policy orchestrator functions
as an endless loop. Each iteration orchestrator computes a set of resources that should be affected, then
progressively applies changes to them. If for some reason this set of resources changes over time (e.g. new
projects are added), the future loop iterations will address that. Orchestrator can either upsert or delete
policy resources. For more details, see the description of the action
, and orchestrated_resource
fields.
Note that policy orchestrator do not "manage" the resources it creates. Every iteration is independent and only
minimal history of past actions is retained (apart from Cloud Logging). If orchestrator gets deleted, it does
not affect the resources it created in the past. Those will remain where they were. Same applies if projects are
removed from the orchestrator's scope.
Implements
Inherited Members
Namespace: Google.Apis.OSConfig.v2beta.Data
Assembly: Google.Apis.OSConfig.v2beta.dll
Syntax
public class GoogleCloudOsconfigV2betaPolicyOrchestrator : IDirectResponseSchema
Properties
Action
Required. Action to be done by the orchestrator in projects/{project_id}/zones/{zone_id}
locations defined
by the orchestration_scope
. Allowed values: - UPSERT
- Orchestrator will create or update target
resources. - DELETE
- Orchestrator will delete target resources, if they exist
Declaration
[JsonProperty("action")]
public virtual string Action { get; set; }
Property Value
Type | Description |
---|---|
string |
CreateTime
object representation of CreateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
CreateTimeDateTimeOffset
DateTimeOffset representation of CreateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
CreateTimeRaw
Output only. Timestamp when the policy orchestrator resource was created.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
Description
Optional. Freeform text describing the purpose of the resource.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Labels
Optional. Labels as key value pairs
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
Name
Immutable. Identifier. In form of *
organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id}
*
folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id}
*
projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
OrchestratedResource
Required. Resource to be orchestrated by the policy orchestrator.
Declaration
[JsonProperty("orchestratedResource")]
public virtual GoogleCloudOsconfigV2betaOrchestratedResource OrchestratedResource { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudOsconfigV2betaOrchestratedResource |
OrchestrationScope
Optional. Defines scope for the orchestration, in context of the enclosing PolicyOrchestrator resource. Scope is expanded into a list of pairs, in which the rollout action will take place. Expansion starts with a Folder resource parenting the PolicyOrchestrator resource: - All the descendant projects are listed. - List of project is cross joined with a list of all available zones. - Resulting list of pairs is filtered according to the selectors.
Declaration
[JsonProperty("orchestrationScope")]
public virtual GoogleCloudOsconfigV2betaOrchestrationScope OrchestrationScope { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudOsconfigV2betaOrchestrationScope |
OrchestrationState
Output only. State of the orchestration.
Declaration
[JsonProperty("orchestrationState")]
public virtual GoogleCloudOsconfigV2betaPolicyOrchestratorOrchestrationState OrchestrationState { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudOsconfigV2betaPolicyOrchestratorOrchestrationState |
Reconciling
Output only. Set to true, if the there are ongoing changes being applied by the orchestrator.
Declaration
[JsonProperty("reconciling")]
public virtual bool? Reconciling { get; set; }
Property Value
Type | Description |
---|---|
bool? |
State
Optional. State of the orchestrator. Can be updated to change orchestrator behaviour. Allowed values: -
ACTIVE
- orchestrator is actively looking for actions to be taken. - STOPPED
- orchestrator won't make
any changes. Note: There might be more states added in the future. We use string here instead of an enum, to
avoid the need of propagating new states to all the client code.
Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type | Description |
---|---|
string |
UpdateTime
object representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
UpdateTimeDateTimeOffset
DateTimeOffset representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
UpdateTimeRaw
Output only. Timestamp when the policy orchestrator resource was last modified.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |