| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="gkehub_v1.html">GKE Hub API</a> . <a href="gkehub_v1.projects.html">projects</a> . <a href="gkehub_v1.projects.locations.html">locations</a> . <a href="gkehub_v1.projects.locations.fleets.html">fleets</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a fleet.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Removes a Fleet. There must be no memberships remaining in the Fleet.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the details of a fleet.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns all fleets within an organization or a project that the caller has access to.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a fleet.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Creates a fleet. |
| |
| Args: |
| parent: string, Required. The parent (project and location) where the Fleet will be created. Specified in the format `projects/*/locations/*`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Fleet contains the Fleet-wide metadata and configuration. |
| "createTime": "A String", # Output only. When the Fleet was created. |
| "defaultClusterConfig": { # DefaultClusterConfig describes the default cluster configurations to be applied to all clusters born-in-fleet. # Optional. The default cluster configurations to apply across the fleet. |
| "binaryAuthorizationConfig": { # BinaryAuthorizationConfig defines the fleet level configuration of binary authorization feature. # Optional. Enable/Disable binary authorization features for the cluster. |
| "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}`. |
| }, |
| ], |
| }, |
| "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. |
| "complianceStandards": [ # List of enabled compliance standards. |
| { |
| "standard": "A String", # Name of the compliance standard. |
| }, |
| ], |
| "mode": "A String", # Defines the enablement mode for Compliance Posture. |
| }, |
| "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. |
| "mode": "A String", # Sets which mode to use for Security Posture features. |
| "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. |
| }, |
| }, |
| "deleteTime": "A String", # Output only. When the Fleet was deleted. |
| "displayName": "A String", # Optional. A user-assigned display name of the Fleet. When present, it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `Production Fleet` |
| "labels": { # Optional. Labels for this Fleet. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Output only. The full, unique resource name of this fleet in the format of `projects/{project}/locations/{location}/fleets/{fleet}`. Each Google Cloud project can have at most one fleet resource, named "default". |
| "state": { # FleetLifecycleState describes the state of a Fleet resource. # Output only. State of the namespace resource. |
| "code": "A String", # Output only. The current state of the Fleet resource. |
| }, |
| "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Fleet resources. If a Fleet resource is deleted and another resource with the same name is created, it gets a different uid. |
| "updateTime": "A String", # Output only. When the Fleet was last updated. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Removes a Fleet. There must be no memberships remaining in the Fleet. |
| |
| Args: |
| name: string, Required. The Fleet resource name in the format `projects/*/locations/*/fleets/*`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Returns the details of a fleet. |
| |
| Args: |
| name: string, Required. The Fleet resource name in the format `projects/*/locations/*/fleets/*`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Fleet contains the Fleet-wide metadata and configuration. |
| "createTime": "A String", # Output only. When the Fleet was created. |
| "defaultClusterConfig": { # DefaultClusterConfig describes the default cluster configurations to be applied to all clusters born-in-fleet. # Optional. The default cluster configurations to apply across the fleet. |
| "binaryAuthorizationConfig": { # BinaryAuthorizationConfig defines the fleet level configuration of binary authorization feature. # Optional. Enable/Disable binary authorization features for the cluster. |
| "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}`. |
| }, |
| ], |
| }, |
| "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. |
| "complianceStandards": [ # List of enabled compliance standards. |
| { |
| "standard": "A String", # Name of the compliance standard. |
| }, |
| ], |
| "mode": "A String", # Defines the enablement mode for Compliance Posture. |
| }, |
| "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. |
| "mode": "A String", # Sets which mode to use for Security Posture features. |
| "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. |
| }, |
| }, |
| "deleteTime": "A String", # Output only. When the Fleet was deleted. |
| "displayName": "A String", # Optional. A user-assigned display name of the Fleet. When present, it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `Production Fleet` |
| "labels": { # Optional. Labels for this Fleet. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Output only. The full, unique resource name of this fleet in the format of `projects/{project}/locations/{location}/fleets/{fleet}`. Each Google Cloud project can have at most one fleet resource, named "default". |
| "state": { # FleetLifecycleState describes the state of a Fleet resource. # Output only. State of the namespace resource. |
| "code": "A String", # Output only. The current state of the Fleet resource. |
| }, |
| "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Fleet resources. If a Fleet resource is deleted and another resource with the same name is created, it gets a different uid. |
| "updateTime": "A String", # Output only. When the Fleet was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Returns all fleets within an organization or a project that the caller has access to. |
| |
| Args: |
| parent: string, Required. The organization or project to list for Fleets under, in the format `organizations/*/locations/*` or `projects/*/locations/*`. (required) |
| pageSize: integer, Optional. The maximum number of fleets to return. The service may return fewer than this value. If unspecified, at most 200 fleets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| pageToken: string, Optional. A page token, received from a previous `ListFleets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFleets` 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 the `GkeHub.ListFleetsResponse` method. |
| "fleets": [ # The list of matching fleets. |
| { # Fleet contains the Fleet-wide metadata and configuration. |
| "createTime": "A String", # Output only. When the Fleet was created. |
| "defaultClusterConfig": { # DefaultClusterConfig describes the default cluster configurations to be applied to all clusters born-in-fleet. # Optional. The default cluster configurations to apply across the fleet. |
| "binaryAuthorizationConfig": { # BinaryAuthorizationConfig defines the fleet level configuration of binary authorization feature. # Optional. Enable/Disable binary authorization features for the cluster. |
| "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}`. |
| }, |
| ], |
| }, |
| "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. |
| "complianceStandards": [ # List of enabled compliance standards. |
| { |
| "standard": "A String", # Name of the compliance standard. |
| }, |
| ], |
| "mode": "A String", # Defines the enablement mode for Compliance Posture. |
| }, |
| "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. |
| "mode": "A String", # Sets which mode to use for Security Posture features. |
| "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. |
| }, |
| }, |
| "deleteTime": "A String", # Output only. When the Fleet was deleted. |
| "displayName": "A String", # Optional. A user-assigned display name of the Fleet. When present, it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `Production Fleet` |
| "labels": { # Optional. Labels for this Fleet. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Output only. The full, unique resource name of this fleet in the format of `projects/{project}/locations/{location}/fleets/{fleet}`. Each Google Cloud project can have at most one fleet resource, named "default". |
| "state": { # FleetLifecycleState describes the state of a Fleet resource. # Output only. State of the namespace resource. |
| "code": "A String", # Output only. The current state of the Fleet resource. |
| }, |
| "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Fleet resources. If a Fleet resource is deleted and another resource with the same name is created, it gets a different uid. |
| "updateTime": "A String", # Output only. When the Fleet was last updated. |
| }, |
| ], |
| "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. The token is only valid for 1h. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates a fleet. |
| |
| Args: |
| name: string, Output only. The full, unique resource name of this fleet in the format of `projects/{project}/locations/{location}/fleets/{fleet}`. Each Google Cloud project can have at most one fleet resource, named "default". (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Fleet contains the Fleet-wide metadata and configuration. |
| "createTime": "A String", # Output only. When the Fleet was created. |
| "defaultClusterConfig": { # DefaultClusterConfig describes the default cluster configurations to be applied to all clusters born-in-fleet. # Optional. The default cluster configurations to apply across the fleet. |
| "binaryAuthorizationConfig": { # BinaryAuthorizationConfig defines the fleet level configuration of binary authorization feature. # Optional. Enable/Disable binary authorization features for the cluster. |
| "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}`. |
| }, |
| ], |
| }, |
| "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. |
| "complianceStandards": [ # List of enabled compliance standards. |
| { |
| "standard": "A String", # Name of the compliance standard. |
| }, |
| ], |
| "mode": "A String", # Defines the enablement mode for Compliance Posture. |
| }, |
| "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. |
| "mode": "A String", # Sets which mode to use for Security Posture features. |
| "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. |
| }, |
| }, |
| "deleteTime": "A String", # Output only. When the Fleet was deleted. |
| "displayName": "A String", # Optional. A user-assigned display name of the Fleet. When present, it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `Production Fleet` |
| "labels": { # Optional. Labels for this Fleet. |
| "a_key": "A String", |
| }, |
| "name": "A String", # Output only. The full, unique resource name of this fleet in the format of `projects/{project}/locations/{location}/fleets/{fleet}`. Each Google Cloud project can have at most one fleet resource, named "default". |
| "state": { # FleetLifecycleState describes the state of a Fleet resource. # Output only. State of the namespace resource. |
| "code": "A String", # Output only. The current state of the Fleet resource. |
| }, |
| "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Fleet resources. If a Fleet resource is deleted and another resource with the same name is created, it gets a different uid. |
| "updateTime": "A String", # Output only. When the Fleet was last updated. |
| } |
| |
| updateMask: string, Required. The fields to be updated; |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
