GKE Hub API . projects . locations . rollouts

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Retrieve a single rollout.

Args:
  name: string, Required. The name of the rollout to retrieve. projects/{project}/locations/{location}/rollouts/{rollout} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Rollout contains the Rollout metadata and configuration.
  "completeTime": "A String", # Output only. The timestamp at which the Rollout was completed.
  "createTime": "A String", # Output only. The timestamp at which the Rollout was created.
  "deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted.
  "displayName": "A String", # Optional. Human readable display name of the Rollout.
  "etag": "A String", # Output only. etag of the Rollout Ex. abc1234
  "excludedClusters": [ # Optional. Output only. The excluded clusters from the rollout.
    { # An excluded cluster from the rollout.
      "membership": "A String", # Output only. The name of the fleet Membership resource associated to the excluded cluster.
      "reason": "A String", # Output only. The reason for excluding the cluster from the rollout.
    },
  ],
  "feature": { # Feature config to use for Rollout. # Optional. Feature config to use for Rollout.
    "binaryAuthorizationConfig": { # BinaryAuthorizationConfig defines the fleet level configuration of binary authorization feature. # Optional. Configuration for Binary Authorization.
      "evaluationMode": "A String", # Optional. Mode of operation for binauthz policy evaluation.
      "policyBindings": [ # Optional. Binauthz policies that apply to this cluster.
        { # Binauthz policy that applies to this cluster.
          "name": "A String", # The relative resource name of the binauthz platform policy to audit. GKE platform policies have the following format: `projects/{project_number}/platforms/gke/policies/{policy_id}`.
        },
      ],
    },
    "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Configuration for Security Posture.
      "mode": "A String", # Sets which mode to use for Security Posture features.
      "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
    },
  },
  "labels": { # Optional. Labels for this Rollout.
    "a_key": "A String",
  },
  "membershipStates": { # Output only. States of upgrading control plane or node pool targets of a single cluster (GKE Hub membership) that's part of this Rollout. The key is the membership name of the cluster. The value is the state of the cluster.
    "a_key": { # Metadata about single cluster (GKE Hub membership) that's part of this Rollout.
      "lastUpdateTime": "A String", # Optional. Output only. The time this status and any related Rollout-specific details for the membership were updated.
      "stageAssignment": 42, # Output only. The stage assignment of this cluster in this rollout.
      "targets": [ # Output only. The targets of the rollout - clusters or node pools that are being upgraded. All targets belongs to the same cluster, identified by the membership name (key of membership_states map).
        { # Metadata about the status of targets (clusters or node pools) involved in the Rollout.
          "cluster": "A String", # Optional. Output only. The resource link of the Cluster resource upgraded in this Rollout. It is formatted as: ///projects//locations//clusters/. I.e. for GKE clusters, it is formatted as: //container.googleapis.com/projects//locations//clusters/. For GDCE, it is formatted as: //edgecontainer.googleapis.com/projects//locations//clusters/.
          "nodePool": "A String", # Optional. Output only. The resource link of the NodePool resource upgraded in this Rollout. It is formatted as: ///projects//locations//clusters//nodePools/.
          "operation": "A String", # Optional. Output only. The operation resource name performing the mutation.
          "reason": "A String", # Optional. Output only. A human-readable description of the current status.
          "state": "A String", # Output only. The high-level, machine-readable status of this Rollout for the target.
        },
      ],
    },
  },
  "name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`.
  "rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`. Empty for user initiated rollouts.
  "schedule": { # Schedule represents the schedule of the Rollout. # Output only. The schedule of the Rollout.
    "waves": [ # Output only. The schedule of each wave in the Rollout.
      { # WaveSchedule represents the schedule of a single rollout wave.
        "waveEndTime": "A String", # Output only. The time at which the wave ends.
        "waveNumber": 42, # Output only. The wave number to which this schedule applies.
        "waveStartTime": "A String", # Output only. The time at which the wave starts.
      },
    ],
  },
  "stages": [ # Output only. The stages of the Rollout. Note: this is only populated for google-initiated rollouts.
    { # Stage represents a single stage in the Rollout.
      "endTime": "A String", # Optional. Output only. The time at which the wave ended.
      "soakDuration": "A String", # Optional. Duration to soak after this wave before starting the next wave.
      "stageNumber": 42, # Output only. The wave number to which this status applies.
      "startTime": "A String", # Optional. Output only. The time at which the wave started.
      "state": "A String", # Output only. The state of the wave.
    },
  ],
  "state": "A String", # Output only. State specifies various states of the Rollout.
  "stateReason": "A String", # Output only. A human-readable description explaining the reason for the current state.
  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Rollout resources. If a Rollout resource is deleted and another resource with the same name is created, it gets a different uid.
  "updateTime": "A String", # Output only. The timestamp at which the Rollout was last updated.
  "versionUpgrade": { # Config for version upgrade of clusters. # Optional. Config for version upgrade of clusters. Note: Currently for GDCE clusters only.
    "desiredVersion": "A String", # Optional. Desired version of the component.
    "type": "A String", # Optional. Type of version upgrade specifies which component should be upgraded.
  },
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Retrieve the list of all rollouts.

Args:
  parent: string, Required. The parent, which owns this collection of rollout. Format: projects/{project}/locations/{location} (required)
  filter: string, Optional. Lists Rollouts that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
  pageSize: integer, The maximum number of rollout to return. The service may return fewer than this value. If unspecified, at most 50 rollouts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, A page token, received from a previous `ListRollouts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRollouts` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for listing rollouts.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "rollouts": [ # The rollouts from the specified parent resource.
    { # Rollout contains the Rollout metadata and configuration.
      "completeTime": "A String", # Output only. The timestamp at which the Rollout was completed.
      "createTime": "A String", # Output only. The timestamp at which the Rollout was created.
      "deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted.
      "displayName": "A String", # Optional. Human readable display name of the Rollout.
      "etag": "A String", # Output only. etag of the Rollout Ex. abc1234
      "excludedClusters": [ # Optional. Output only. The excluded clusters from the rollout.
        { # An excluded cluster from the rollout.
          "membership": "A String", # Output only. The name of the fleet Membership resource associated to the excluded cluster.
          "reason": "A String", # Output only. The reason for excluding the cluster from the rollout.
        },
      ],
      "feature": { # Feature config to use for Rollout. # Optional. Feature config to use for Rollout.
        "binaryAuthorizationConfig": { # BinaryAuthorizationConfig defines the fleet level configuration of binary authorization feature. # Optional. Configuration for Binary Authorization.
          "evaluationMode": "A String", # Optional. Mode of operation for binauthz policy evaluation.
          "policyBindings": [ # Optional. Binauthz policies that apply to this cluster.
            { # Binauthz policy that applies to this cluster.
              "name": "A String", # The relative resource name of the binauthz platform policy to audit. GKE platform policies have the following format: `projects/{project_number}/platforms/gke/policies/{policy_id}`.
            },
          ],
        },
        "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Configuration for Security Posture.
          "mode": "A String", # Sets which mode to use for Security Posture features.
          "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
        },
      },
      "labels": { # Optional. Labels for this Rollout.
        "a_key": "A String",
      },
      "membershipStates": { # Output only. States of upgrading control plane or node pool targets of a single cluster (GKE Hub membership) that's part of this Rollout. The key is the membership name of the cluster. The value is the state of the cluster.
        "a_key": { # Metadata about single cluster (GKE Hub membership) that's part of this Rollout.
          "lastUpdateTime": "A String", # Optional. Output only. The time this status and any related Rollout-specific details for the membership were updated.
          "stageAssignment": 42, # Output only. The stage assignment of this cluster in this rollout.
          "targets": [ # Output only. The targets of the rollout - clusters or node pools that are being upgraded. All targets belongs to the same cluster, identified by the membership name (key of membership_states map).
            { # Metadata about the status of targets (clusters or node pools) involved in the Rollout.
              "cluster": "A String", # Optional. Output only. The resource link of the Cluster resource upgraded in this Rollout. It is formatted as: ///projects//locations//clusters/. I.e. for GKE clusters, it is formatted as: //container.googleapis.com/projects//locations//clusters/. For GDCE, it is formatted as: //edgecontainer.googleapis.com/projects//locations//clusters/.
              "nodePool": "A String", # Optional. Output only. The resource link of the NodePool resource upgraded in this Rollout. It is formatted as: ///projects//locations//clusters//nodePools/.
              "operation": "A String", # Optional. Output only. The operation resource name performing the mutation.
              "reason": "A String", # Optional. Output only. A human-readable description of the current status.
              "state": "A String", # Output only. The high-level, machine-readable status of this Rollout for the target.
            },
          ],
        },
      },
      "name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`.
      "rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`. Empty for user initiated rollouts.
      "schedule": { # Schedule represents the schedule of the Rollout. # Output only. The schedule of the Rollout.
        "waves": [ # Output only. The schedule of each wave in the Rollout.
          { # WaveSchedule represents the schedule of a single rollout wave.
            "waveEndTime": "A String", # Output only. The time at which the wave ends.
            "waveNumber": 42, # Output only. The wave number to which this schedule applies.
            "waveStartTime": "A String", # Output only. The time at which the wave starts.
          },
        ],
      },
      "stages": [ # Output only. The stages of the Rollout. Note: this is only populated for google-initiated rollouts.
        { # Stage represents a single stage in the Rollout.
          "endTime": "A String", # Optional. Output only. The time at which the wave ended.
          "soakDuration": "A String", # Optional. Duration to soak after this wave before starting the next wave.
          "stageNumber": 42, # Output only. The wave number to which this status applies.
          "startTime": "A String", # Optional. Output only. The time at which the wave started.
          "state": "A String", # Output only. The state of the wave.
        },
      ],
      "state": "A String", # Output only. State specifies various states of the Rollout.
      "stateReason": "A String", # Output only. A human-readable description explaining the reason for the current state.
      "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Rollout resources. If a Rollout resource is deleted and another resource with the same name is created, it gets a different uid.
      "updateTime": "A String", # Output only. The timestamp at which the Rollout was last updated.
      "versionUpgrade": { # Config for version upgrade of clusters. # Optional. Config for version upgrade of clusters. Note: Currently for GDCE clusters only.
        "desiredVersion": "A String", # Optional. Desired version of the component.
        "type": "A String", # Optional. Type of version upgrade specifies which component should be upgraded.
      },
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.