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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
<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="firebaseapphosting_v1.html">Firebase App Hosting API</a> . <a href="firebaseapphosting_v1.projects.html">projects</a> . <a href="firebaseapphosting_v1.projects.locations.html">locations</a> . <a href="firebaseapphosting_v1.projects.locations.backends.html">backends</a> . <a href="firebaseapphosting_v1.projects.locations.backends.traffic.html">traffic</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">Gets information about a backend's traffic.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a backend's traffic.</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>Gets information about a backend's traffic.
Args:
name: string, Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Controls traffic configuration for the backend.
"annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
"a_key": "A String",
},
"createTime": "A String", # Output only. Time at which the backend was created.
"current": { # A list of traffic splits that together represent where traffic is being routed. # Output only. Current state of traffic allocation for the backend. When setting `target`, this field may differ for some time until the desired state is reached.
"splits": [ # Required. The list of traffic splits.
{ # The traffic allocation for the backend.
"build": "A String", # Required. The build that traffic is being routed to.
"percent": 42, # Required. The percentage of traffic to send to the build. Currently must be 100% or 0%.
},
],
},
"etag": "A String", # Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.
"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects.
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name of the backend's traffic. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`.
"reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make the backend's `current` match the requested `target` list.
"rolloutPolicy": { # The policy for how automatic builds and rollouts are triggered and rolled out. # A rollout policy specifies how new builds and automatic deployments are created.
"codebaseBranch": "A String", # If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen.
"disabled": True or False, # Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy.
"disabledTime": "A String", # Output only. If `disabled` is set, the time at which the automatic rollouts were disabled.
},
"target": { # A list of traffic splits that together represent where traffic is being routed. # Set to manually control the desired traffic for the backend. This will cause `current` to eventually match this value. The percentages must add up to 100%.
"splits": [ # Required. The list of traffic splits.
{ # The traffic allocation for the backend.
"build": "A String", # Required. The build that traffic is being routed to.
"percent": 42, # Required. The percentage of traffic to send to the build. Currently must be 100% or 0%.
},
],
},
"uid": "A String", # Output only. System-assigned, unique identifier.
"updateTime": "A String", # Output only. Time at which the backend was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
<pre>Updates a backend's traffic.
Args:
name: string, Identifier. The resource name of the backend's traffic. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`. (required)
body: object, The request body.
The object takes the form of:
{ # Controls traffic configuration for the backend.
"annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
"a_key": "A String",
},
"createTime": "A String", # Output only. Time at which the backend was created.
"current": { # A list of traffic splits that together represent where traffic is being routed. # Output only. Current state of traffic allocation for the backend. When setting `target`, this field may differ for some time until the desired state is reached.
"splits": [ # Required. The list of traffic splits.
{ # The traffic allocation for the backend.
"build": "A String", # Required. The build that traffic is being routed to.
"percent": 42, # Required. The percentage of traffic to send to the build. Currently must be 100% or 0%.
},
],
},
"etag": "A String", # Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.
"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects.
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name of the backend's traffic. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`.
"reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make the backend's `current` match the requested `target` list.
"rolloutPolicy": { # The policy for how automatic builds and rollouts are triggered and rolled out. # A rollout policy specifies how new builds and automatic deployments are created.
"codebaseBranch": "A String", # If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen.
"disabled": True or False, # Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy.
"disabledTime": "A String", # Output only. If `disabled` is set, the time at which the automatic rollouts were disabled.
},
"target": { # A list of traffic splits that together represent where traffic is being routed. # Set to manually control the desired traffic for the backend. This will cause `current` to eventually match this value. The percentages must add up to 100%.
"splits": [ # Required. The list of traffic splits.
{ # The traffic allocation for the backend.
"build": "A String", # Required. The build that traffic is being routed to.
"percent": 42, # Required. The percentage of traffic to send to the build. Currently must be 100% or 0%.
},
],
},
"uid": "A String", # Output only. System-assigned, unique identifier.
"updateTime": "A String", # Output only. Time at which the backend was last updated.
}
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the traffic resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
validateOnly: boolean, Optional. Indicates that the request should be validated, without persisting the request or updating any resources.
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>
|
