| <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="eventarc_v1.html">Eventarc API</a> . <a href="eventarc_v1.projects.html">projects</a> . <a href="eventarc_v1.projects.locations.html">locations</a> . <a href="eventarc_v1.projects.locations.providers.html">providers</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 single Provider.</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">List providers.</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 single Provider. |
| |
| Args: |
| name: string, Required. The name of the provider to get. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A representation of the Provider resource. |
| "displayName": "A String", # Output only. Human friendly name for the Provider. For example "Cloud Storage". |
| "eventTypes": [ # Output only. Event types for this provider. |
| { # A representation of the event type resource. |
| "description": "A String", # Output only. Human friendly description of what the event type is about. For example "Bucket created in Cloud Storage". |
| "eventSchemaUri": "A String", # Output only. URI for the event schema. For example "https://github.com/googleapis/google-cloudevents/blob/master/proto/google/events/cloud/storage/v1/events.proto" |
| "filteringAttributes": [ # Output only. Filtering attributes for the event type. |
| { # A representation of the FilteringAttribute resource. Filtering attributes are per event type. |
| "attribute": "A String", # Output only. Attribute used for filtering the event type. |
| "description": "A String", # Output only. Description of the purpose of the attribute. |
| "pathPatternSupported": True or False, # Output only. If true, the attribute accepts matching expressions in the Eventarc PathPattern format. |
| "required": True or False, # Output only. If true, the triggers for this provider should always specify a filter on these attributes. Trigger creation will fail otherwise. |
| }, |
| ], |
| "type": "A String", # Output only. The full name of the event type (for example, "google.cloud.storage.object.v1.finalized"). In the form of {provider-specific-prefix}.{resource}.{version}.{verb}. Types MUST be versioned and event schemas are guaranteed to remain backward compatible within one version. Note that event type versions and API versions do not need to match. |
| }, |
| ], |
| "name": "A String", # Output only. In `projects/{project}/locations/{location}/providers/{provider_id}` format. |
| }</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>List providers. |
| |
| Args: |
| parent: string, Required. The parent of the provider to get. (required) |
| filter: string, The filter field that the list request will filter on. |
| orderBy: string, The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting oder is ascending. To specify descending order for a field, append a `desc` suffix; for example: `name desc, _id`. |
| pageSize: integer, The maximum number of providers to return on each page. |
| pageToken: string, The page token; provide the value from the `next_page_token` field in a previous `ListProviders` call to retrieve the subsequent page. When paginating, all other parameters provided to `ListProviders` 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: |
| |
| { # The response message for the `ListProviders` method. |
| "nextPageToken": "A String", # A page token that can be sent to `ListProviders` to request the next page. If this is empty, then there are no more pages. |
| "providers": [ # The requested providers, up to the number specified in `page_size`. |
| { # A representation of the Provider resource. |
| "displayName": "A String", # Output only. Human friendly name for the Provider. For example "Cloud Storage". |
| "eventTypes": [ # Output only. Event types for this provider. |
| { # A representation of the event type resource. |
| "description": "A String", # Output only. Human friendly description of what the event type is about. For example "Bucket created in Cloud Storage". |
| "eventSchemaUri": "A String", # Output only. URI for the event schema. For example "https://github.com/googleapis/google-cloudevents/blob/master/proto/google/events/cloud/storage/v1/events.proto" |
| "filteringAttributes": [ # Output only. Filtering attributes for the event type. |
| { # A representation of the FilteringAttribute resource. Filtering attributes are per event type. |
| "attribute": "A String", # Output only. Attribute used for filtering the event type. |
| "description": "A String", # Output only. Description of the purpose of the attribute. |
| "pathPatternSupported": True or False, # Output only. If true, the attribute accepts matching expressions in the Eventarc PathPattern format. |
| "required": True or False, # Output only. If true, the triggers for this provider should always specify a filter on these attributes. Trigger creation will fail otherwise. |
| }, |
| ], |
| "type": "A String", # Output only. The full name of the event type (for example, "google.cloud.storage.object.v1.finalized"). In the form of {provider-specific-prefix}.{resource}.{version}.{verb}. Types MUST be versioned and event schemas are guaranteed to remain backward compatible within one version. Note that event type versions and API versions do not need to match. |
| }, |
| ], |
| "name": "A String", # Output only. In `projects/{project}/locations/{location}/providers/{provider_id}` format. |
| }, |
| ], |
| "unreachable": [ # Unreachable resources, if any. |
| "A String", |
| ], |
| }</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> |
| |
| </body></html> |
