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

Creates TargetSite in a batch.

Args:
  parent: string, Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SiteSearchEngineService.BatchCreateTargetSites method.
  "requests": [ # Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.
    { # Request message for SiteSearchEngineService.CreateTargetSite method.
      "parent": "A String", # Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
      "targetSite": { # A target site for the SiteSearchEngine. # Required. The TargetSite to create.
        "exactMatch": True or False, # Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
        "failureReason": { # Site search indexing failure reasons. # Output only. Failure reason.
          "quotaFailure": { # Failed due to insufficient quota. # Failed due to insufficient quota.
            "totalRequiredQuota": "A String", # This number is an estimation on how much total quota this project needs to successfully complete indexing.
          },
        },
        "generatedUriPattern": "A String", # Output only. This is system-generated based on the provided_uri_pattern.
        "indexingStatus": "A String", # Output only. Indexing status.
        "name": "A String", # Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.
        "providedUriPattern": "A String", # Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
        "rootDomainUri": "A String", # Output only. Root domain of the provided_uri_pattern.
        "siteVerificationInfo": { # Verification information for target sites in advanced site search. # Output only. Site ownership and validity verification status.
          "siteVerificationState": "A String", # Site verification state indicating the ownership and validity.
          "verifyTime": "A String", # Latest site verification time.
        },
        "type": "A String", # The type of the target site, e.g., whether the site is to be included or excluded.
        "updateTime": "A String", # Output only. The target site's last updated time.
      },
    },
  ],
}

  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.
  },
}

close()

Close httplib2 connections.

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

Creates a TargetSite.

Args:
  parent: string, Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A target site for the SiteSearchEngine.
  "exactMatch": True or False, # Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
  "failureReason": { # Site search indexing failure reasons. # Output only. Failure reason.
    "quotaFailure": { # Failed due to insufficient quota. # Failed due to insufficient quota.
      "totalRequiredQuota": "A String", # This number is an estimation on how much total quota this project needs to successfully complete indexing.
    },
  },
  "generatedUriPattern": "A String", # Output only. This is system-generated based on the provided_uri_pattern.
  "indexingStatus": "A String", # Output only. Indexing status.
  "name": "A String", # Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.
  "providedUriPattern": "A String", # Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
  "rootDomainUri": "A String", # Output only. Root domain of the provided_uri_pattern.
  "siteVerificationInfo": { # Verification information for target sites in advanced site search. # Output only. Site ownership and validity verification status.
    "siteVerificationState": "A String", # Site verification state indicating the ownership and validity.
    "verifyTime": "A String", # Latest site verification time.
  },
  "type": "A String", # The type of the target site, e.g., whether the site is to be included or excluded.
  "updateTime": "A String", # Output only. The target site's last updated time.
}

  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, x__xgafv=None)

Deletes a TargetSite.

Args:
name: string, Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. (required)
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 a TargetSite.

Args:
  name: string, Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A target site for the SiteSearchEngine.
  "exactMatch": True or False, # Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
  "failureReason": { # Site search indexing failure reasons. # Output only. Failure reason.
    "quotaFailure": { # Failed due to insufficient quota. # Failed due to insufficient quota.
      "totalRequiredQuota": "A String", # This number is an estimation on how much total quota this project needs to successfully complete indexing.
    },
  },
  "generatedUriPattern": "A String", # Output only. This is system-generated based on the provided_uri_pattern.
  "indexingStatus": "A String", # Output only. Indexing status.
  "name": "A String", # Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.
  "providedUriPattern": "A String", # Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
  "rootDomainUri": "A String", # Output only. Root domain of the provided_uri_pattern.
  "siteVerificationInfo": { # Verification information for target sites in advanced site search. # Output only. Site ownership and validity verification status.
    "siteVerificationState": "A String", # Site verification state indicating the ownership and validity.
    "verifyTime": "A String", # Latest site verification time.
  },
  "type": "A String", # The type of the target site, e.g., whether the site is to be included or excluded.
  "updateTime": "A String", # Output only. The target site's last updated time.
}

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

Gets a list of TargetSites.

Args:
  parent: string, Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. (required)
  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
  pageToken: string, A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` 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:

    { # Response message for SiteSearchEngineService.ListTargetSites method.
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "targetSites": [ # List of TargetSites.
    { # A target site for the SiteSearchEngine.
      "exactMatch": True or False, # Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
      "failureReason": { # Site search indexing failure reasons. # Output only. Failure reason.
        "quotaFailure": { # Failed due to insufficient quota. # Failed due to insufficient quota.
          "totalRequiredQuota": "A String", # This number is an estimation on how much total quota this project needs to successfully complete indexing.
        },
      },
      "generatedUriPattern": "A String", # Output only. This is system-generated based on the provided_uri_pattern.
      "indexingStatus": "A String", # Output only. Indexing status.
      "name": "A String", # Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.
      "providedUriPattern": "A String", # Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
      "rootDomainUri": "A String", # Output only. Root domain of the provided_uri_pattern.
      "siteVerificationInfo": { # Verification information for target sites in advanced site search. # Output only. Site ownership and validity verification status.
        "siteVerificationState": "A String", # Site verification state indicating the ownership and validity.
        "verifyTime": "A String", # Latest site verification time.
      },
      "type": "A String", # The type of the target site, e.g., whether the site is to be included or excluded.
      "updateTime": "A String", # Output only. The target site's last updated time.
    },
  ],
  "totalSize": 42, # The total number of items matching the request. This will always be populated in the response.
}

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, x__xgafv=None)

Updates a TargetSite.

Args:
  name: string, Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated. (required)
  body: object, The request body.
    The object takes the form of:

{ # A target site for the SiteSearchEngine.
  "exactMatch": True or False, # Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
  "failureReason": { # Site search indexing failure reasons. # Output only. Failure reason.
    "quotaFailure": { # Failed due to insufficient quota. # Failed due to insufficient quota.
      "totalRequiredQuota": "A String", # This number is an estimation on how much total quota this project needs to successfully complete indexing.
    },
  },
  "generatedUriPattern": "A String", # Output only. This is system-generated based on the provided_uri_pattern.
  "indexingStatus": "A String", # Output only. Indexing status.
  "name": "A String", # Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.
  "providedUriPattern": "A String", # Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
  "rootDomainUri": "A String", # Output only. Root domain of the provided_uri_pattern.
  "siteVerificationInfo": { # Verification information for target sites in advanced site search. # Output only. Site ownership and validity verification status.
    "siteVerificationState": "A String", # Site verification state indicating the ownership and validity.
    "verifyTime": "A String", # Latest site verification time.
  },
  "type": "A String", # The type of the target site, e.g., whether the site is to be included or excluded.
  "updateTime": "A String", # Output only. The target site's last updated time.
}

  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.
  },
}

Discovery Engine API . projects . locations . dataStores . siteSearchEngine . targetSites

Instance Methods

Method Details