Analytics Hub API . projects . locations . dataExchanges . queryTemplates

approve(name, body=None, x__xgafv=None)

Approves a query template.

Args:
  name: string, Required. The resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for approving a QueryTemplate.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
  "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
  "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
  "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
  "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
  "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
  "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
    "definitionBody": "A String", # Optional. The definition body of the routine.
    "routineType": "A String", # Required. The type of routine.
  },
  "state": "A String", # Output only. The QueryTemplate lifecycle state.
  "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}

close()

Close httplib2 connections.

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

Creates a new QueryTemplate

Args:
  parent: string, Required. The parent resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myQueryTemplate`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
  "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
  "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
  "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
  "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
  "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
  "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
    "definitionBody": "A String", # Optional. The definition body of the routine.
    "routineType": "A String", # Required. The type of routine.
  },
  "state": "A String", # Output only. The QueryTemplate lifecycle state.
  "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}

  queryTemplateId: string, Required. The ID of the QueryTemplate to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
  "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
  "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
  "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
  "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
  "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
  "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
    "definitionBody": "A String", # Optional. The definition body of the routine.
    "routineType": "A String", # Required. The type of routine.
  },
  "state": "A String", # Output only. The QueryTemplate lifecycle state.
  "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}

delete(name, x__xgafv=None)

Deletes a query template.

Args:
  name: string, Required. The resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (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 a QueryTemplate

Args:
  name: string, Required. The parent resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
  "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
  "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
  "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
  "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
  "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
  "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
    "definitionBody": "A String", # Optional. The definition body of the routine.
    "routineType": "A String", # Required. The type of routine.
  },
  "state": "A String", # Output only. The QueryTemplate lifecycle state.
  "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}

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

Lists all QueryTemplates in a given project and location.

Args:
  parent: string, Required. The parent resource path of the QueryTemplates. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
  pageSize: integer, Optional. The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
  pageToken: string, Optional. Page token, returned by a previous call, to request the next page of results.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to the list of QueryTemplates.
  "nextPageToken": "A String", # A token to request the next page of results.
  "queryTemplates": [ # The list of QueryTemplates.
    { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
      "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
      "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
      "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
      "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
      "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
      "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
      "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
      "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
        "definitionBody": "A String", # Optional. The definition body of the routine.
        "routineType": "A String", # Required. The type of routine.
      },
      "state": "A String", # Output only. The QueryTemplate lifecycle state.
      "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
    },
  ],
}

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 existing QueryTemplate

Args:
  name: string, Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456` (required)
  body: object, The request body.
    The object takes the form of:

{ # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
  "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
  "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
  "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
  "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
  "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
  "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
    "definitionBody": "A String", # Optional. The definition body of the routine.
    "routineType": "A String", # Required. The type of routine.
  },
  "state": "A String", # Output only. The QueryTemplate lifecycle state.
  "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}

  updateMask: string, Optional. Field mask specifies the fields to update in the query template resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
  "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
  "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
  "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
  "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
  "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
  "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
    "definitionBody": "A String", # Optional. The definition body of the routine.
    "routineType": "A String", # Required. The type of routine.
  },
  "state": "A String", # Output only. The QueryTemplate lifecycle state.
  "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}

submit(name, body=None, x__xgafv=None)

Submits a query template for approval.

Args:
  name: string, Required. The resource path of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/myqueryTemplate`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for submitting a QueryTemplate.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A query template is a container for sharing table-valued functions defined by contributors in a data clean room.
  "createTime": "A String", # Output only. Timestamp when the QueryTemplate was created.
  "description": "A String", # Optional. Short description of the QueryTemplate. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.
  "displayName": "A String", # Required. Human-readable display name of the QueryTemplate. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
  "documentation": "A String", # Optional. Documentation describing the QueryTemplate.
  "name": "A String", # Output only. The resource name of the QueryTemplate. e.g. `projects/myproject/locations/us/dataExchanges/123/queryTemplates/456`
  "primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "proposer": "A String", # Optional. Will be deprecated. Email or URL of the primary point of contact of the QueryTemplate. Max Length: 1000 bytes.
  "routine": { # Represents a bigquery routine. # Optional. The routine associated with the QueryTemplate.
    "definitionBody": "A String", # Optional. The definition body of the routine.
    "routineType": "A String", # Required. The type of routine.
  },
  "state": "A String", # Output only. The QueryTemplate lifecycle state.
  "updateTime": "A String", # Output only. Timestamp when the QueryTemplate was last modified.
}