| <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="integrations_v1.html">Application Integration API</a> . <a href="integrations_v1.projects.html">projects</a> . <a href="integrations_v1.projects.locations.html">locations</a> . <a href="integrations_v1.projects.locations.sfdcInstances.html">sfdcInstances</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="integrations_v1.projects.locations.sfdcInstances.sfdcChannels.html">sfdcChannels()</a></code> | |
| </p> | |
| <p class="firstline">Returns the sfdcChannels Resource.</p> | |
| <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="#create">create(parent, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes an sfdc instance.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.</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> | |
| <p class="toc_element"> | |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.</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="create">create(parent, body=None, x__xgafv=None)</code> | |
| <pre>Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance. | |
| Args: | |
| parent: string, Required. "projects/{project}/locations/{location}" format. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # The SfdcInstance resource use to hold channels and connection config data. | |
| "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC | |
| "A String", | |
| ], | |
| "createTime": "A String", # Output only. Time when the instance is created | |
| "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted. | |
| "description": "A String", # A description of the sfdc instance. | |
| "displayName": "A String", # User selected unique name/alias to easily reference an instance. | |
| "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. | |
| "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig). | |
| "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce. | |
| "updateTime": "A String", # Output only. Time when the instance was last updated | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # The SfdcInstance resource use to hold channels and connection config data. | |
| "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC | |
| "A String", | |
| ], | |
| "createTime": "A String", # Output only. Time when the instance is created | |
| "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted. | |
| "description": "A String", # A description of the sfdc instance. | |
| "displayName": "A String", # User selected unique name/alias to easily reference an instance. | |
| "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. | |
| "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig). | |
| "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce. | |
| "updateTime": "A String", # Output only. Time when the instance was last updated | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> | |
| <pre>Deletes an sfdc instance. | |
| Args: | |
| name: string, Required. The name that is associated with the SfdcInstance. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown. | |
| Args: | |
| name: string, Required. The name that is associated with the SfdcInstance. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # The SfdcInstance resource use to hold channels and connection config data. | |
| "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC | |
| "A String", | |
| ], | |
| "createTime": "A String", # Output only. Time when the instance is created | |
| "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted. | |
| "description": "A String", # A description of the sfdc instance. | |
| "displayName": "A String", # User selected unique name/alias to easily reference an instance. | |
| "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. | |
| "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig). | |
| "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce. | |
| "updateTime": "A String", # Output only. Time when the instance was last updated | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code> | |
| <pre>Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only. | |
| Args: | |
| parent: string, Required. The client, which owns this collection of SfdcInstances. (required) | |
| filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters. | |
| pageSize: integer, The size of entries in the response. If unspecified, defaults to 100. | |
| pageToken: string, The token returned in the previous response. | |
| readMask: string, The mask which specifies fields that need to be returned in the SfdcInstance's response. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response to list SfdcInstances. | |
| "nextPageToken": "A String", # The token used to retrieve the next page of results. | |
| "sfdcInstances": [ # The list of SfdcInstances retrieved. | |
| { # The SfdcInstance resource use to hold channels and connection config data. | |
| "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC | |
| "A String", | |
| ], | |
| "createTime": "A String", # Output only. Time when the instance is created | |
| "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted. | |
| "description": "A String", # A description of the sfdc instance. | |
| "displayName": "A String", # User selected unique name/alias to easily reference an instance. | |
| "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. | |
| "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig). | |
| "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce. | |
| "updateTime": "A String", # Output only. Time when the instance was last updated | |
| }, | |
| ], | |
| }</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> | |
| <div class="method"> | |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> | |
| <pre>Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance. | |
| Args: | |
| name: string, Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # The SfdcInstance resource use to hold channels and connection config data. | |
| "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC | |
| "A String", | |
| ], | |
| "createTime": "A String", # Output only. Time when the instance is created | |
| "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted. | |
| "description": "A String", # A description of the sfdc instance. | |
| "displayName": "A String", # User selected unique name/alias to easily reference an instance. | |
| "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. | |
| "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig). | |
| "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce. | |
| "updateTime": "A String", # Output only. Time when the instance was last updated | |
| } | |
| updateMask: string, Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # The SfdcInstance resource use to hold channels and connection config data. | |
| "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC | |
| "A String", | |
| ], | |
| "createTime": "A String", # Output only. Time when the instance is created | |
| "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted. | |
| "description": "A String", # A description of the sfdc instance. | |
| "displayName": "A String", # User selected unique name/alias to easily reference an instance. | |
| "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. | |
| "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig). | |
| "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce. | |
| "updateTime": "A String", # Output only. Time when the instance was last updated | |
| }</pre> | |
| </div> | |
| </body></html> |