File: config_v1.projects.locations.previews.resourceChanges.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (205 lines) | stat: -rw-r--r-- 9,050 bytes parent folder | download
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<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="config_v1.html">Infrastructure Manager API</a> . <a href="config_v1.projects.html">projects</a> . <a href="config_v1.projects.locations.html">locations</a> . <a href="config_v1.projects.locations.previews.html">previews</a> . <a href="config_v1.projects.locations.previews.resourceChanges.html">resourceChanges</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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a ResourceChange for a given preview.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists ResourceChanges for a given preview.</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="get">get(name, x__xgafv=None)</code>
  <pre>Get a ResourceChange for a given preview.

Args:
  name: string, Required. The name of the resource change to retrieve. Format: &#x27;projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}&#x27;. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource change represents a change to a resource in the state file.
  &quot;intent&quot;: &quot;A String&quot;, # Output only. The intent of the resource change.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the resource change. Format: &#x27;projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}&#x27;.
  &quot;propertyChanges&quot;: [ # Output only. The property changes of the resource change.
    { # A property change represents a change to a property in the state file.
      &quot;after&quot;: &quot;&quot;, # Output only. Representations of the object value after the actions.
      &quot;afterSensitivePaths&quot;: [ # Output only. The paths of sensitive fields in `after`. Paths are relative to `path`.
        &quot;A String&quot;,
      ],
      &quot;before&quot;: &quot;&quot;, # Output only. Representations of the object value before the actions.
      &quot;beforeSensitivePaths&quot;: [ # Output only. The paths of sensitive fields in `before`. Paths are relative to `path`.
        &quot;A String&quot;,
      ],
      &quot;path&quot;: &quot;A String&quot;, # Output only. The path of the property change.
    },
  ],
  &quot;terraformInfo&quot;: { # Terraform info of a ResourceChange. # Output only. Terraform info of the resource change.
    &quot;actions&quot;: [ # Output only. TF resource actions.
      &quot;A String&quot;,
    ],
    &quot;address&quot;: &quot;A String&quot;, # Output only. TF resource address that uniquely identifies the resource.
    &quot;provider&quot;: &quot;A String&quot;, # Output only. TF resource provider.
    &quot;resourceName&quot;: &quot;A String&quot;, # Output only. TF resource name.
    &quot;type&quot;: &quot;A String&quot;, # Output only. TF resource type.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists ResourceChanges for a given preview.

Args:
  parent: string, Required. The parent in whose context the ResourceChanges are listed. The parent value is in the format: &#x27;projects/{project_id}/locations/{location}/previews/{preview}&#x27;. (required)
  filter: string, Optional. Lists the resource changes that match the filter expression. A filter expression filters the resource changes listed in the response. The expression must be of the form &#x27;{field} {operator} {value}&#x27; where operators: &#x27;&lt;&#x27;, &#x27;&gt;&#x27;, &#x27;&lt;=&#x27;, &#x27;&gt;=&#x27;, &#x27;!=&#x27;, &#x27;=&#x27;, &#x27;:&#x27; are supported (colon &#x27;:&#x27; represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = &quot;projects/foo/locations/us-central1/previews/dep/resourceChanges/baz
  orderBy: string, Optional. Field to use to sort the list.
  pageSize: integer, Optional. When requesting a page of resource changes, &#x27;page_size&#x27; specifies number of resource changes to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
  pageToken: string, Optional. Token returned by previous call to &#x27;ListResourceChanges&#x27; which specifies the position in the list from where to continue listing the resource changes.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A response to a &#x27;ListResourceChanges&#x27; call. Contains a list of ResourceChanges.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to request the next page of resources from the &#x27;ListResourceChanges&#x27; method. The value of an empty string means that there are no more resources to return.
  &quot;resourceChanges&quot;: [ # List of ResourceChanges.
    { # A resource change represents a change to a resource in the state file.
      &quot;intent&quot;: &quot;A String&quot;, # Output only. The intent of the resource change.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the resource change. Format: &#x27;projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}&#x27;.
      &quot;propertyChanges&quot;: [ # Output only. The property changes of the resource change.
        { # A property change represents a change to a property in the state file.
          &quot;after&quot;: &quot;&quot;, # Output only. Representations of the object value after the actions.
          &quot;afterSensitivePaths&quot;: [ # Output only. The paths of sensitive fields in `after`. Paths are relative to `path`.
            &quot;A String&quot;,
          ],
          &quot;before&quot;: &quot;&quot;, # Output only. Representations of the object value before the actions.
          &quot;beforeSensitivePaths&quot;: [ # Output only. The paths of sensitive fields in `before`. Paths are relative to `path`.
            &quot;A String&quot;,
          ],
          &quot;path&quot;: &quot;A String&quot;, # Output only. The path of the property change.
        },
      ],
      &quot;terraformInfo&quot;: { # Terraform info of a ResourceChange. # Output only. Terraform info of the resource change.
        &quot;actions&quot;: [ # Output only. TF resource actions.
          &quot;A String&quot;,
        ],
        &quot;address&quot;: &quot;A String&quot;, # Output only. TF resource address that uniquely identifies the resource.
        &quot;provider&quot;: &quot;A String&quot;, # Output only. TF resource provider.
        &quot;resourceName&quot;: &quot;A String&quot;, # Output only. TF resource name.
        &quot;type&quot;: &quot;A String&quot;, # Output only. TF resource type.
      },
    },
  ],
  &quot;unreachable&quot;: [ # Unreachable resources, if any.
    &quot;A String&quot;,
  ],
}</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>