| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="remotebuildexecution_v1.html">Remote Build Execution API</a> . <a href="remotebuildexecution_v1.v1.html">v1</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#watch">watch(target=None, resumeMarker=None, Semantics=None, Semantics=None, Semantics=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Start a streaming RPC to get watch information from the server.</p> |
| 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| 82 | <code class="details" id="watch">watch(target=None, resumeMarker=None, Semantics=None, Semantics=None, Semantics=None, x__xgafv=None)</code> |
| 83 | <pre>Start a streaming RPC to get watch information from the server. |
| 84 | |
| 85 | Args: |
| 86 | target: string, The `target` value **must** be a valid URL path pointing to an entity |
| 87 | to watch. Note that the service name **must** be |
| 88 | removed from the target field (e.g., the target field must say |
| 89 | "/foo/bar", not "myservice.googleapis.com/foo/bar"). A client is |
| 90 | also allowed to pass system-specific parameters in the URL that |
| 91 | are only obeyed by some implementations. Some parameters will be |
| 92 | implementation-specific. However, some have predefined meaning |
| 93 | and are listed here: |
| 94 | |
| 95 | * recursive = true|false [default=false] |
| 96 | If set to true, indicates that the client wants to watch all elements |
| 97 | of entities in the subtree rooted at the entity's name in `target`. For |
| 98 | descendants that are not the immediate children of the target, the |
| 99 | `Change.element` will contain slashes. |
| 100 | |
| 101 | Note that some namespaces and entities will not support recursive |
| 102 | watching. When watching such an entity, a client must not set recursive |
| 103 | to true. Otherwise, it will receive an `UNIMPLEMENTED` error. |
| 104 | |
| 105 | Normal URL encoding must be used inside `target`. For example, if a query |
| 106 | parameter name or value, or the non-query parameter portion of `target` |
| 107 | contains a special character, it must be %-encoded. We recommend that |
| 108 | clients and servers use their runtime's URL library to produce and consume |
| 109 | target values. |
| 110 | resumeMarker: string, The `resume_marker` specifies how much of the existing underlying state is |
| 111 | delivered to the client when the watch request is received by the |
| 112 | system. The client can set this marker in one of the following ways to get |
| 113 | different semantics: |
| 114 | |
| 115 | * Parameter is not specified or has the value "". |
| 116 | Semantics: Fetch initial state. |
| 117 | The client wants the entity's initial state to be delivered. See the |
| 118 | description in "Initial State". |
| 119 | |
| 120 | * Parameter is set to the string "now" (UTF-8 encoding). |
| 121 | Semantics: Fetch new changes only. |
| 122 | The client just wants to get the changes received by the system after |
| 123 | the watch point. The system may deliver changes from before the watch |
| 124 | point as well. |
| 125 | |
| 126 | * Parameter is set to a value received in an earlier |
| 127 | `Change.resume_marker` field while watching the same entity. |
| 128 | Semantics: Resume from a specific point. |
| 129 | The client wants to receive the changes from a specific point; this |
| 130 | value must correspond to a value received in the `Change.resume_marker` |
| 131 | field. The system may deliver changes from before the `resume_marker` |
| 132 | as well. If the system cannot resume the stream from this point (e.g., |
| 133 | if it is too far behind in the stream), it can raise the |
| 134 | `FAILED_PRECONDITION` error. |
| 135 | |
| 136 | An implementation MUST support an unspecified parameter and the |
| 137 | empty string "" marker (initial state fetching) and the "now" marker. |
| 138 | It need not support resuming from a specific point. |
| 139 | x__xgafv: string, V1 error format. |
| 140 | Allowed values |
| 141 | 1 - v1 error format |
| 142 | 2 - v2 error format |
| 143 | |
| 144 | Returns: |
| 145 | An object of the form: |
| 146 | |
| 147 | { # A batch of Change messages. |
| 148 | "changes": [ # A list of Change messages. |
| 149 | { # A Change indicates the most recent state of an element. |
| 150 | "continued": True or False, # If true, this Change is followed by more Changes that are in the same group |
| 151 | # as this Change. |
| 152 | "state": "A String", # The state of the `element`. |
| 153 | "resumeMarker": "A String", # If present, provides a compact representation of all the messages that have |
| 154 | # been received by the caller for the given entity, e.g., it could be a |
| 155 | # sequence number or a multi-part timestamp/version vector. This marker can |
| 156 | # be provided in the Request message, allowing the caller to resume the |
| 157 | # stream watching at a specific point without fetching the initial state. |
| 158 | "data": { # The actual change data. This field is present only when `state() == EXISTS` |
| 159 | # or `state() == ERROR`. Please see google.protobuf.Any about how to use |
| 160 | # the Any type. |
| 161 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 162 | }, |
| 163 | "element": "A String", # Name of the element, interpreted relative to the entity's actual |
| 164 | # name. "" refers to the entity itself. The element name is a valid |
| 165 | # UTF-8 string. |
| 166 | }, |
| 167 | ], |
| 168 | }</pre> |
| 169 | </div> |
| 170 | |
| 171 | </body></html> |