Class FeedsServiceClient (0.6.4) 

FeedsServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.chronicle_v1.services.feeds_service.transports.base.FeedsServiceTransport,
            typing.Callable[
                [...],
                google.cloud.chronicle_v1.services.feeds_service.transports.base.FeedsServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

FeedsService contains procedures for managing Chronicle third-party feeds.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
FeedsServiceTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

FeedsServiceClient

FeedsServiceClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.chronicle_v1.services.feeds_service.transports.base.FeedsServiceTransport,
            typing.Callable[
                [...],
                google.cloud.chronicle_v1.services.feeds_service.transports.base.FeedsServiceTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the feeds service client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Optional[Union[str,FeedsServiceTransport,Callable[..., FeedsServiceTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the FeedsServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

cancel_operation

cancel_operation(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_feed

create_feed(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.feed.CreateFeedRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    feed: typing.Optional[google.cloud.chronicle_v1.types.feed.Feed] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.feed.Feed

Creates a feed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_create_feed():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.CreateFeedRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_feed(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.CreateFeedRequest, dict]

The request object. Request message for CreateFeed.
parent str

Required. The parent resource where this Feed will be created. Format: projects/{project}/locations/{location}/instances/{instance} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
feed google.cloud.chronicle_v1.types.Feed

Required. Feed to create. This corresponds to the feed field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.types.Feed Feed is a resource that contains feed information needed to create a feed.

delete_feed

delete_feed(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.feed.DeleteFeedRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a feed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_delete_feed():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.DeleteFeedRequest(
        name="name_value",
    )

    # Make the request
    client.delete_feed(request=request)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.DeleteFeedRequest, dict]

The request object. Request message to delete a feed.
name str

Required. The ID of the feed to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/feeds/{feed} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

delete_operation

delete_operation(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.DeleteOperationRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.DeleteOperationRequest

The request object. Request message for DeleteOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

disable_feed

disable_feed(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.feed.DisableFeedRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.feed.Feed

Disable feed for ingestion. Make FeedState ARCHIVED.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_disable_feed():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.DisableFeedRequest(
        name="name_value",
    )

    # Make the request
    response = client.disable_feed(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.DisableFeedRequest, dict]

The request object. DisableFeed request message.
name str

Required. The name of the feed to disable. Format: projects/{project}/locations/{location}/instances/{instance}/feeds/{feed} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.types.Feed Feed is a resource that contains feed information needed to create a feed.

enable_feed

enable_feed(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.feed.EnableFeedRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.feed.Feed

Enable feed for ingestion.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_enable_feed():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.EnableFeedRequest(
        name="name_value",
    )

    # Make the request
    response = client.enable_feed(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.EnableFeedRequest, dict]

The request object. EnableFeed request message.
name str

Required. The name of the feed to enable. Format: projects/{project}/locations/{location}/instances/{instance}/feeds/{feed} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.types.Feed Feed is a resource that contains feed information needed to create a feed.

feed_pack_path

feed_pack_path(project: str, location: str, instance: str, feed_pack: str) -> str

Returns a fully-qualified feed_pack string.

feed_path

feed_path(project: str, location: str, instance: str, feed: str) -> str

Returns a fully-qualified feed string.

feed_service_account_path

feed_service_account_path(
    project: str, location: str, instance: str, feed_service_account: str
) -> str

Returns a fully-qualified feed_service_account string.

feed_source_type_schema_path

feed_source_type_schema_path(
    project: str, location: str, instance: str, feed_source_type: str
) -> str

Returns a fully-qualified feed_source_type_schema string.

fetch_service_account_for_customer

fetch_service_account_for_customer(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.feed.FetchServiceAccountForCustomerRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.feed.FeedServiceAccount

Fetch Chronicle's service account used for ingesting data from Cloud Storage buckets.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_fetch_service_account_for_customer():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.FetchServiceAccountForCustomerRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.fetch_service_account_for_customer(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.FetchServiceAccountForCustomerRequest, dict]

The request object. Request message for FetchServiceAccountForCustomer.
parent str

Required. The parent resource where this FeedServiceAccount will be created. Format: projects/{project}/locations/{location}/instances/{instance} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.types.FeedServiceAccount FeedServiceAccount is a resource that wraps the feed service account's name.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
FeedsServiceClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
FeedsServiceClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
FeedsServiceClient The constructed client.

generate_secret

generate_secret(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.feed.GenerateSecretRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.feed.GenerateSecretResponse

Generates a new secret for https push feeds which do not support jwt tokens. Secrets once generated should be copied and stored in safe place to be used while configuring https push feeds.Please note that you can always generate a new secret again for a feed using this API but it will invalidate the previously generated secret for the feed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_generate_secret():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.GenerateSecretRequest(
        name="name_value",
    )

    # Make the request
    response = client.generate_secret(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.GenerateSecretRequest, dict]

The request object. GenerateSecret request message.
name str

Required. The name of the feed to for which to generate secret. Format: projects/{project}/locations/{location}/instances/{instance}/feeds/{feed} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.types.GenerateSecretResponse GenerateSecret response message.

get_feed

get_feed(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.feed.GetFeedRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.feed.Feed

Gets a feed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_get_feed():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.GetFeedRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_feed(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.GetFeedRequest, dict]

The request object. Request message to retrieve a feed.
name str

Required. The ID of the feed to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/feeds/{feed} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.types.Feed Feed is a resource that contains feed information needed to create a feed.

get_feed_pack

get_feed_pack(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.feed.GetFeedPackRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.feed.FeedPack

Gets a feed pack.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_get_feed_pack():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.GetFeedPackRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_feed_pack(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.GetFeedPackRequest, dict]

The request object. Request message for GetFeedPack.
name str

Required. The ID of the feed pack to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/feedPacks/{feedPack} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.types.FeedPack FeedPack is a logical container for related LogTypes for which feeds can be configured.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.GetOperationRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.Operation An Operation object.

import_push_logs

import_push_logs(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.feed.ImportPushLogsRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api.httpbody_pb2.HttpBody

Import logs coming from https push feeds. All log entries must be valid UTF-8. A single invalid event will cause the entire request to be rejected.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_import_push_logs():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.ImportPushLogsRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.import_push_logs(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.ImportPushLogsRequest, dict]

The request object. ImportPushLogsRequest request message.
parent str

Required. The parent, which owns this collection of logs. Format: projects/{project}/locations/{location}/instances/{instance}/feeds/{feed} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api.httpbody_pb2.HttpBody Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

list_feed_packs

list_feed_packs(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.feed.ListFeedPacksRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.services.feeds_service.pagers.ListFeedPacksPager

Lists Packs for which feeds can be configured.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_list_feed_packs():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.ListFeedPacksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_feed_packs(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.ListFeedPacksRequest, dict]

The request object. Request message for ListFeedPacks.
parent str

Required. The parent resource where this content pack will be created. Format: projects/{project}/locations/{location}/instances/{instance} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.services.feeds_service.pagers.ListFeedPacksPager Response message for ListFeedPacks. Iterating over this object will yield results and resolve additional pages automatically.

list_feed_source_type_schemas

list_feed_source_type_schemas(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.feed.ListFeedSourceTypeSchemasRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.chronicle_v1.services.feeds_service.pagers.ListFeedSourceTypeSchemasPager
)

List all FeedSourceTypeSchemas.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_list_feed_source_type_schemas():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.ListFeedSourceTypeSchemasRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_feed_source_type_schemas(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.ListFeedSourceTypeSchemasRequest, dict]

The request object. ListFeedSourceTypeSchemas request message. Note that Feed schemas do not contain customer data, so are not scoped to a particular customer.
parent str

Required. The parent, which owns this collection of FeedSourceTypeSchemas. Format: projects/{project}/locations/{location}/instances/{instance} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.services.feeds_service.pagers.ListFeedSourceTypeSchemasPager ListFeedSourceTypeSchemas response message. Iterating over this object will yield results and resolve additional pages automatically.

list_feeds

list_feeds(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.feed.ListFeedsRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.services.feeds_service.pagers.ListFeedsPager

Lists all feeds for the customer.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_list_feeds():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.ListFeedsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_feeds(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.ListFeedsRequest, dict]

The request object. Request message for ListFeed.
parent str

Required. The parent resource where this Feed will be created. Format: projects/{project}/locations/{location}/instances/{instance} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.services.feeds_service.pagers.ListFeedsPager Response message for ListFeed. Iterating over this object will yield results and resolve additional pages automatically.

list_log_type_schemas

list_log_type_schemas(
    request: typing.Optional[
        typing.Union[
            google.cloud.chronicle_v1.types.feed.ListLogTypeSchemasRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.services.feeds_service.pagers.ListLogTypeSchemasPager

List all LogTypeSchemas compatible with a given FeedSourceType.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_list_log_type_schemas():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.ListLogTypeSchemasRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_log_type_schemas(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.ListLogTypeSchemasRequest, dict]

The request object. ListLogTypeSchemas request message. Note that feed schemas do not contain customer data, so are not scoped to a particular customer.
parent str

Required. The parent, which owns this collection of LogTypeSchemas. Format: Format: projects/{project}/locations/{location}/instances/{instance}/feedSourceTypeSchemas/{feed_source_type} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.services.feeds_service.pagers.ListLogTypeSchemasPager ListLogTypeSchemas response message. Iterating over this object will yield results and resolve additional pages automatically.

list_operations

list_operations(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

log_type_path

log_type_path(project: str, location: str, instance: str, log_type: str) -> str

Returns a fully-qualified log_type string.

log_type_schema_path

log_type_schema_path(
    project: str, location: str, instance: str, feed_source_type: str, log_type: str
) -> str

Returns a fully-qualified log_type_schema string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_feed_pack_path

parse_feed_pack_path(path: str) -> typing.Dict[str, str]

Parses a feed_pack path into its component segments.

parse_feed_path

parse_feed_path(path: str) -> typing.Dict[str, str]

Parses a feed path into its component segments.

parse_feed_service_account_path

parse_feed_service_account_path(path: str) -> typing.Dict[str, str]

Parses a feed_service_account path into its component segments.

parse_feed_source_type_schema_path

parse_feed_source_type_schema_path(path: str) -> typing.Dict[str, str]

Parses a feed_source_type_schema path into its component segments.

parse_log_type_path

parse_log_type_path(path: str) -> typing.Dict[str, str]

Parses a log_type path into its component segments.

parse_log_type_schema_path

parse_log_type_schema_path(path: str) -> typing.Dict[str, str]

Parses a log_type_schema path into its component segments.

update_feed

update_feed(
    request: typing.Optional[
        typing.Union[google.cloud.chronicle_v1.types.feed.UpdateFeedRequest, dict]
    ] = None,
    *,
    feed: typing.Optional[google.cloud.chronicle_v1.types.feed.Feed] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.chronicle_v1.types.feed.Feed

Updates the full feed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import chronicle_v1

def sample_update_feed():
    # Create a client
    client = chronicle_v1.FeedsServiceClient()

    # Initialize request argument(s)
    request = chronicle_v1.UpdateFeedRequest(
    )

    # Make the request
    response = client.update_feed(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.chronicle_v1.types.UpdateFeedRequest, dict]

The request object. Request message for UpdateFeed.
feed google.cloud.chronicle_v1.types.Feed

Required. Feed to update. Updates full feed object. This corresponds to the feed field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Specifies which fields to update. If empty, update the full feed. To update the display name, pass only displayName and no other fields. To update other fields, pass a comma-separated list of fields to update and omit displayName. The update fails if an existing displayName is sent in the update request. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.chronicle_v1.types.Feed Feed is a resource that contains feed information needed to create a feed.