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

Creates a new CustomConnector in a given project and location.

Args:
  parent: string, Required. Parent resource of the CreateCustomConnector, of the form: `projects/{project}/locations/*` (required)
  body: object, The request body.
    The object takes the form of:

{ # CustomConnector represents the custom connector defined by the customer as part of byoc.
  "activeConnectorVersions": [ # Output only. Active connector versions.
    "A String",
  ],
  "allConnectorVersions": [ # Output only. All connector versions.
    "A String",
  ],
  "allMarketplaceVersions": [ # Output only. All marketplace versions.
    "A String",
  ],
  "createTime": "A String", # Output only. Created time.
  "customConnectorType": "A String", # Required. Type of the custom connector.
  "description": "A String", # Optional. Description of the resource.
  "displayName": "A String", # Optional. Display name.
  "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
    "a_key": "A String",
  },
  "logo": "A String", # Optional. Logo of the resource.
  "name": "A String", # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
  "publishedMarketplaceVersions": [ # Output only. Published marketplace versions.
    "A String",
  ],
  "updateTime": "A String", # Output only. Updated time.
}

  customConnectorId: string, Required. Identifier to assign to the CreateCustomConnector. Must be unique within scope of the parent resource.
  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.
  },
}

delete(name, force=None, x__xgafv=None)

Deletes a single CustomConnector.

Args:
name: string, Required. Resource name of the form: `projects/{project}/locations/{location}/customConnectors/{connector}` (required)
force: boolean, Optional. If set to true, any customConnectorVersion which is a child resource will also be deleted. https://aip.dev/135#cascading-delete
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.
},
}

get(name, x__xgafv=None)

Gets details of a single CustomConnector.

Args:
  name: string, Required. Resource name of the form: `projects/*/locations/*/customConnectors/*` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # CustomConnector represents the custom connector defined by the customer as part of byoc.
  "activeConnectorVersions": [ # Output only. Active connector versions.
    "A String",
  ],
  "allConnectorVersions": [ # Output only. All connector versions.
    "A String",
  ],
  "allMarketplaceVersions": [ # Output only. All marketplace versions.
    "A String",
  ],
  "createTime": "A String", # Output only. Created time.
  "customConnectorType": "A String", # Required. Type of the custom connector.
  "description": "A String", # Optional. Description of the resource.
  "displayName": "A String", # Optional. Display name.
  "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
    "a_key": "A String",
  },
  "logo": "A String", # Optional. Logo of the resource.
  "name": "A String", # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
  "publishedMarketplaceVersions": [ # Output only. Published marketplace versions.
    "A String",
  ],
  "updateTime": "A String", # Output only. Updated time.
}

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

List CustomConnectorVersions in a given project

Args:
  parent: string, Required. Parent resource of the custom connectors, of the form: `projects/*/locations/*` Only global location is supported for CustomConnector resource. (required)
  filter: string, Filter string.
  pageSize: integer, Page size.
  pageToken: string, Page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for Connectors.ListCustomConnectors.
  "customConnectors": [ # A list of customConnectors.
    { # CustomConnector represents the custom connector defined by the customer as part of byoc.
      "activeConnectorVersions": [ # Output only. Active connector versions.
        "A String",
      ],
      "allConnectorVersions": [ # Output only. All connector versions.
        "A String",
      ],
      "allMarketplaceVersions": [ # Output only. All marketplace versions.
        "A String",
      ],
      "createTime": "A String", # Output only. Created time.
      "customConnectorType": "A String", # Required. Type of the custom connector.
      "description": "A String", # Optional. Description of the resource.
      "displayName": "A String", # Optional. Display name.
      "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
        "a_key": "A String",
      },
      "logo": "A String", # Optional. Logo of the resource.
      "name": "A String", # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
      "publishedMarketplaceVersions": [ # Output only. Published marketplace versions.
        "A String",
      ],
      "updateTime": "A String", # Output only. Updated time.
    },
  ],
  "nextPageToken": "A String", # Next page token.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}

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 the parameters of a CustomConnector.

Args:
  name: string, Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector} (required)
  body: object, The request body.
    The object takes the form of:

{ # CustomConnector represents the custom connector defined by the customer as part of byoc.
  "activeConnectorVersions": [ # Output only. Active connector versions.
    "A String",
  ],
  "allConnectorVersions": [ # Output only. All connector versions.
    "A String",
  ],
  "allMarketplaceVersions": [ # Output only. All marketplace versions.
    "A String",
  ],
  "createTime": "A String", # Output only. Created time.
  "customConnectorType": "A String", # Required. Type of the custom connector.
  "description": "A String", # Optional. Description of the resource.
  "displayName": "A String", # Optional. Display name.
  "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
    "a_key": "A String",
  },
  "logo": "A String", # Optional. Logo of the resource.
  "name": "A String", # Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}
  "publishedMarketplaceVersions": [ # Output only. Published marketplace versions.
    "A String",
  ],
  "updateTime": "A String", # Output only. Updated time.
}

  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Connector 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. Set the mask as "*" for full replacement, which means all fields will be overwritten.
  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.
  },
}

Connectors API . projects . locations . global_ . customConnectors

Instance Methods

Method Details