File: gkehub_v1beta.organizations.locations.fleets.html

package info (click to toggle)
python-googleapi 2.187.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 562,316 kB
  • sloc: python: 11,087; javascript: 249; sh: 114; makefile: 59
file content (165 lines) | stat: -rw-r--r-- 7,512 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<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_v1beta.html">GKE Hub API</a> . <a href="gkehub_v1beta.organizations.html">organizations</a> . <a href="gkehub_v1beta.organizations.locations.html">locations</a> . <a href="gkehub_v1beta.organizations.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="#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>
<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="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.
  &quot;fleets&quot;: [ # The list of matching fleets.
    { # Fleet contains the Fleet-wide metadata and configuration.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. When the Fleet was created.
      &quot;defaultClusterConfig&quot;: { # 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.
        &quot;binaryAuthorizationConfig&quot;: { # BinaryAuthorizationConfig defines the fleet level configuration of binary authorization feature. # Optional. Enable/Disable binary authorization features for the cluster.
          &quot;evaluationMode&quot;: &quot;A String&quot;, # Optional. Mode of operation for binauthz policy evaluation.
          &quot;policyBindings&quot;: [ # Optional. Binauthz policies that apply to this cluster.
            { # Binauthz policy that applies to this cluster.
              &quot;name&quot;: &quot;A String&quot;, # 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}`.
            },
          ],
        },
        &quot;compliancePostureConfig&quot;: { # 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.
          &quot;complianceStandards&quot;: [ # List of enabled compliance standards.
            {
              &quot;standard&quot;: &quot;A String&quot;, # Name of the compliance standard.
            },
          ],
          &quot;mode&quot;: &quot;A String&quot;, # Defines the enablement mode for Compliance Posture.
        },
        &quot;securityPostureConfig&quot;: { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster.
          &quot;mode&quot;: &quot;A String&quot;, # Sets which mode to use for Security Posture features.
          &quot;vulnerabilityMode&quot;: &quot;A String&quot;, # Sets which mode to use for vulnerability scanning.
        },
      },
      &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. When the Fleet was deleted.
      &quot;displayName&quot;: &quot;A String&quot;, # 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`
      &quot;labels&quot;: { # Optional. Labels for this Fleet.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;name&quot;: &quot;A String&quot;, # 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 &quot;default&quot;.
      &quot;state&quot;: { # FleetLifecycleState describes the state of a Fleet resource. # Output only. State of the namespace resource.
        &quot;code&quot;: &quot;A String&quot;, # Output only. The current state of the Fleet resource.
      },
      &quot;uid&quot;: &quot;A String&quot;, # 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.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. When the Fleet was last updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # 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 &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>