Application Integration API . projects . locations . sfdcInstances

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

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
}

delete(name, x__xgafv=None)

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); }
}

get(name, x__xgafv=None)

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
}

list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

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/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
    },
  ],
}

list_next()

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.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

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
}