id int32 0 252k | repo stringlengths 7 55 | path stringlengths 4 127 | func_name stringlengths 1 88 | original_string stringlengths 75 19.8k | language stringclasses 1
value | code stringlengths 75 19.8k | code_tokens list | docstring stringlengths 3 17.3k | docstring_tokens list | sha stringlengths 40 40 | url stringlengths 87 242 |
|---|---|---|---|---|---|---|---|---|---|---|---|
28,300 | googleapis/google-cloud-python | redis/google/cloud/redis_v1/gapic/cloud_redis_client.py | CloudRedisClient.import_instance | def import_instance(
self,
name,
input_config,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Import a Redis RDB snapshot file from GCS into a Redis instance.
Redis may sto... | python | def import_instance(
self,
name,
input_config,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Import a Redis RDB snapshot file from GCS into a Redis instance.
Redis may sto... | [
"def",
"import_instance",
"(",
"self",
",",
"name",
",",
"input_config",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"D... | Import a Redis RDB snapshot file from GCS into a Redis instance.
Redis may stop serving during this operation. Instance state will be
IMPORTING for entire operation. When complete, the instance will contain
only data from the imported file.
The returned operation is automatically delet... | [
"Import",
"a",
"Redis",
"RDB",
"snapshot",
"file",
"from",
"GCS",
"into",
"a",
"Redis",
"instance",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/redis/google/cloud/redis_v1/gapic/cloud_redis_client.py#L646-L734 |
28,301 | googleapis/google-cloud-python | monitoring/google/cloud/monitoring_v3/gapic/notification_channel_service_client.py | NotificationChannelServiceClient.notification_channel_path | def notification_channel_path(cls, project, notification_channel):
"""Return a fully-qualified notification_channel string."""
return google.api_core.path_template.expand(
"projects/{project}/notificationChannels/{notification_channel}",
project=project,
notification_... | python | def notification_channel_path(cls, project, notification_channel):
"""Return a fully-qualified notification_channel string."""
return google.api_core.path_template.expand(
"projects/{project}/notificationChannels/{notification_channel}",
project=project,
notification_... | [
"def",
"notification_channel_path",
"(",
"cls",
",",
"project",
",",
"notification_channel",
")",
":",
"return",
"google",
".",
"api_core",
".",
"path_template",
".",
"expand",
"(",
"\"projects/{project}/notificationChannels/{notification_channel}\"",
",",
"project",
"=",... | Return a fully-qualified notification_channel string. | [
"Return",
"a",
"fully",
"-",
"qualified",
"notification_channel",
"string",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/monitoring/google/cloud/monitoring_v3/gapic/notification_channel_service_client.py#L101-L107 |
28,302 | googleapis/google-cloud-python | monitoring/google/cloud/monitoring_v3/gapic/notification_channel_service_client.py | NotificationChannelServiceClient.notification_channel_descriptor_path | def notification_channel_descriptor_path(cls, project, channel_descriptor):
"""Return a fully-qualified notification_channel_descriptor string."""
return google.api_core.path_template.expand(
"projects/{project}/notificationChannelDescriptors/{channel_descriptor}",
project=projec... | python | def notification_channel_descriptor_path(cls, project, channel_descriptor):
"""Return a fully-qualified notification_channel_descriptor string."""
return google.api_core.path_template.expand(
"projects/{project}/notificationChannelDescriptors/{channel_descriptor}",
project=projec... | [
"def",
"notification_channel_descriptor_path",
"(",
"cls",
",",
"project",
",",
"channel_descriptor",
")",
":",
"return",
"google",
".",
"api_core",
".",
"path_template",
".",
"expand",
"(",
"\"projects/{project}/notificationChannelDescriptors/{channel_descriptor}\"",
",",
... | Return a fully-qualified notification_channel_descriptor string. | [
"Return",
"a",
"fully",
"-",
"qualified",
"notification_channel_descriptor",
"string",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/monitoring/google/cloud/monitoring_v3/gapic/notification_channel_service_client.py#L110-L116 |
28,303 | googleapis/google-cloud-python | logging/google/cloud/logging/logger.py | Logger.batch | def batch(self, client=None):
"""Return a batch to use as a context manager.
:type client: :class:`~google.cloud.logging.client.Client` or
``NoneType``
:param client: the client to use. If not passed, falls back to the
``client`` stored on the curre... | python | def batch(self, client=None):
"""Return a batch to use as a context manager.
:type client: :class:`~google.cloud.logging.client.Client` or
``NoneType``
:param client: the client to use. If not passed, falls back to the
``client`` stored on the curre... | [
"def",
"batch",
"(",
"self",
",",
"client",
"=",
"None",
")",
":",
"client",
"=",
"self",
".",
"_require_client",
"(",
"client",
")",
"return",
"Batch",
"(",
"self",
",",
"client",
")"
] | Return a batch to use as a context manager.
:type client: :class:`~google.cloud.logging.client.Client` or
``NoneType``
:param client: the client to use. If not passed, falls back to the
``client`` stored on the current topic.
:rtype: :class:`Batch`... | [
"Return",
"a",
"batch",
"to",
"use",
"as",
"a",
"context",
"manager",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/logging/google/cloud/logging/logger.py#L102-L114 |
28,304 | googleapis/google-cloud-python | logging/google/cloud/logging/logger.py | Batch.commit | def commit(self, client=None):
"""Send saved log entries as a single API call.
:type client: :class:`~google.cloud.logging.client.Client` or
``NoneType``
:param client: the client to use. If not passed, falls back to the
``client`` stored on the cur... | python | def commit(self, client=None):
"""Send saved log entries as a single API call.
:type client: :class:`~google.cloud.logging.client.Client` or
``NoneType``
:param client: the client to use. If not passed, falls back to the
``client`` stored on the cur... | [
"def",
"commit",
"(",
"self",
",",
"client",
"=",
"None",
")",
":",
"if",
"client",
"is",
"None",
":",
"client",
"=",
"self",
".",
"client",
"kwargs",
"=",
"{",
"\"logger_name\"",
":",
"self",
".",
"logger",
".",
"full_name",
"}",
"if",
"self",
".",
... | Send saved log entries as a single API call.
:type client: :class:`~google.cloud.logging.client.Client` or
``NoneType``
:param client: the client to use. If not passed, falls back to the
``client`` stored on the current batch. | [
"Send",
"saved",
"log",
"entries",
"as",
"a",
"single",
"API",
"call",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/logging/google/cloud/logging/logger.py#L362-L384 |
28,305 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _bytes_from_json | def _bytes_from_json(value, field):
"""Base64-decode value"""
if _not_null(value, field):
return base64.standard_b64decode(_to_bytes(value)) | python | def _bytes_from_json(value, field):
"""Base64-decode value"""
if _not_null(value, field):
return base64.standard_b64decode(_to_bytes(value)) | [
"def",
"_bytes_from_json",
"(",
"value",
",",
"field",
")",
":",
"if",
"_not_null",
"(",
"value",
",",
"field",
")",
":",
"return",
"base64",
".",
"standard_b64decode",
"(",
"_to_bytes",
"(",
"value",
")",
")"
] | Base64-decode value | [
"Base64",
"-",
"decode",
"value"
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L68-L71 |
28,306 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _time_from_json | def _time_from_json(value, field):
"""Coerce 'value' to a datetime date, if set or not nullable"""
if _not_null(value, field):
if len(value) == 8: # HH:MM:SS
fmt = _TIMEONLY_WO_MICROS
elif len(value) == 15: # HH:MM:SS.micros
fmt = _TIMEONLY_W_MICROS
else:
... | python | def _time_from_json(value, field):
"""Coerce 'value' to a datetime date, if set or not nullable"""
if _not_null(value, field):
if len(value) == 8: # HH:MM:SS
fmt = _TIMEONLY_WO_MICROS
elif len(value) == 15: # HH:MM:SS.micros
fmt = _TIMEONLY_W_MICROS
else:
... | [
"def",
"_time_from_json",
"(",
"value",
",",
"field",
")",
":",
"if",
"_not_null",
"(",
"value",
",",
"field",
")",
":",
"if",
"len",
"(",
"value",
")",
"==",
"8",
":",
"# HH:MM:SS",
"fmt",
"=",
"_TIMEONLY_WO_MICROS",
"elif",
"len",
"(",
"value",
")",
... | Coerce 'value' to a datetime date, if set or not nullable | [
"Coerce",
"value",
"to",
"a",
"datetime",
"date",
"if",
"set",
"or",
"not",
"nullable"
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L146-L155 |
28,307 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _record_from_json | def _record_from_json(value, field):
"""Coerce 'value' to a mapping, if set or not nullable."""
if _not_null(value, field):
record = {}
record_iter = zip(field.fields, value["f"])
for subfield, cell in record_iter:
converter = _CELLDATA_FROM_JSON[subfield.field_type]
... | python | def _record_from_json(value, field):
"""Coerce 'value' to a mapping, if set or not nullable."""
if _not_null(value, field):
record = {}
record_iter = zip(field.fields, value["f"])
for subfield, cell in record_iter:
converter = _CELLDATA_FROM_JSON[subfield.field_type]
... | [
"def",
"_record_from_json",
"(",
"value",
",",
"field",
")",
":",
"if",
"_not_null",
"(",
"value",
",",
"field",
")",
":",
"record",
"=",
"{",
"}",
"record_iter",
"=",
"zip",
"(",
"field",
".",
"fields",
",",
"value",
"[",
"\"f\"",
"]",
")",
"for",
... | Coerce 'value' to a mapping, if set or not nullable. | [
"Coerce",
"value",
"to",
"a",
"mapping",
"if",
"set",
"or",
"not",
"nullable",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L158-L170 |
28,308 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _row_tuple_from_json | def _row_tuple_from_json(row, schema):
"""Convert JSON row data to row with appropriate types.
Note: ``row['f']`` and ``schema`` are presumed to be of the same length.
:type row: dict
:param row: A JSON response row to be converted.
:type schema: tuple
:param schema: A tuple of
... | python | def _row_tuple_from_json(row, schema):
"""Convert JSON row data to row with appropriate types.
Note: ``row['f']`` and ``schema`` are presumed to be of the same length.
:type row: dict
:param row: A JSON response row to be converted.
:type schema: tuple
:param schema: A tuple of
... | [
"def",
"_row_tuple_from_json",
"(",
"row",
",",
"schema",
")",
":",
"row_data",
"=",
"[",
"]",
"for",
"field",
",",
"cell",
"in",
"zip",
"(",
"schema",
",",
"row",
"[",
"\"f\"",
"]",
")",
":",
"converter",
"=",
"_CELLDATA_FROM_JSON",
"[",
"field",
".",... | Convert JSON row data to row with appropriate types.
Note: ``row['f']`` and ``schema`` are presumed to be of the same length.
:type row: dict
:param row: A JSON response row to be converted.
:type schema: tuple
:param schema: A tuple of
:class:`~google.cloud.bigquery.schema.Sc... | [
"Convert",
"JSON",
"row",
"data",
"to",
"row",
"with",
"appropriate",
"types",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L200-L223 |
28,309 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _rows_from_json | def _rows_from_json(values, schema):
"""Convert JSON row data to rows with appropriate types."""
from google.cloud.bigquery import Row
field_to_index = _field_to_index_mapping(schema)
return [Row(_row_tuple_from_json(r, schema), field_to_index) for r in values] | python | def _rows_from_json(values, schema):
"""Convert JSON row data to rows with appropriate types."""
from google.cloud.bigquery import Row
field_to_index = _field_to_index_mapping(schema)
return [Row(_row_tuple_from_json(r, schema), field_to_index) for r in values] | [
"def",
"_rows_from_json",
"(",
"values",
",",
"schema",
")",
":",
"from",
"google",
".",
"cloud",
".",
"bigquery",
"import",
"Row",
"field_to_index",
"=",
"_field_to_index_mapping",
"(",
"schema",
")",
"return",
"[",
"Row",
"(",
"_row_tuple_from_json",
"(",
"r... | Convert JSON row data to rows with appropriate types. | [
"Convert",
"JSON",
"row",
"data",
"to",
"rows",
"with",
"appropriate",
"types",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L226-L231 |
28,310 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _decimal_to_json | def _decimal_to_json(value):
"""Coerce 'value' to a JSON-compatible representation."""
if isinstance(value, decimal.Decimal):
value = str(value)
return value | python | def _decimal_to_json(value):
"""Coerce 'value' to a JSON-compatible representation."""
if isinstance(value, decimal.Decimal):
value = str(value)
return value | [
"def",
"_decimal_to_json",
"(",
"value",
")",
":",
"if",
"isinstance",
"(",
"value",
",",
"decimal",
".",
"Decimal",
")",
":",
"value",
"=",
"str",
"(",
"value",
")",
"return",
"value"
] | Coerce 'value' to a JSON-compatible representation. | [
"Coerce",
"value",
"to",
"a",
"JSON",
"-",
"compatible",
"representation",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L246-L250 |
28,311 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _scalar_field_to_json | def _scalar_field_to_json(field, row_value):
"""Maps a field and value to a JSON-safe value.
Args:
field ( \
:class:`~google.cloud.bigquery.schema.SchemaField`, \
):
The SchemaField to use for type conversion and field name.
row_value (any):
Value to ... | python | def _scalar_field_to_json(field, row_value):
"""Maps a field and value to a JSON-safe value.
Args:
field ( \
:class:`~google.cloud.bigquery.schema.SchemaField`, \
):
The SchemaField to use for type conversion and field name.
row_value (any):
Value to ... | [
"def",
"_scalar_field_to_json",
"(",
"field",
",",
"row_value",
")",
":",
"converter",
"=",
"_SCALAR_VALUE_TO_JSON_ROW",
".",
"get",
"(",
"field",
".",
"field_type",
")",
"if",
"converter",
"is",
"None",
":",
"# STRING doesn't need converting",
"return",
"row_value"... | Maps a field and value to a JSON-safe value.
Args:
field ( \
:class:`~google.cloud.bigquery.schema.SchemaField`, \
):
The SchemaField to use for type conversion and field name.
row_value (any):
Value to be converted, based on the field's type.
Return... | [
"Maps",
"a",
"field",
"and",
"value",
"to",
"a",
"JSON",
"-",
"safe",
"value",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L333-L351 |
28,312 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _field_to_json | def _field_to_json(field, row_value):
"""Convert a field into JSON-serializable values.
Args:
field ( \
:class:`~google.cloud.bigquery.schema.SchemaField`, \
):
The SchemaField to use for type conversion and field name.
row_value (Union[ \
Sequence[l... | python | def _field_to_json(field, row_value):
"""Convert a field into JSON-serializable values.
Args:
field ( \
:class:`~google.cloud.bigquery.schema.SchemaField`, \
):
The SchemaField to use for type conversion and field name.
row_value (Union[ \
Sequence[l... | [
"def",
"_field_to_json",
"(",
"field",
",",
"row_value",
")",
":",
"if",
"row_value",
"is",
"None",
":",
"return",
"None",
"if",
"field",
".",
"mode",
"==",
"\"REPEATED\"",
":",
"return",
"_repeated_field_to_json",
"(",
"field",
",",
"row_value",
")",
"if",
... | Convert a field into JSON-serializable values.
Args:
field ( \
:class:`~google.cloud.bigquery.schema.SchemaField`, \
):
The SchemaField to use for type conversion and field name.
row_value (Union[ \
Sequence[list], \
any, \
]):
... | [
"Convert",
"a",
"field",
"into",
"JSON",
"-",
"serializable",
"values",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L409-L439 |
28,313 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _snake_to_camel_case | def _snake_to_camel_case(value):
"""Convert snake case string to camel case."""
words = value.split("_")
return words[0] + "".join(map(str.capitalize, words[1:])) | python | def _snake_to_camel_case(value):
"""Convert snake case string to camel case."""
words = value.split("_")
return words[0] + "".join(map(str.capitalize, words[1:])) | [
"def",
"_snake_to_camel_case",
"(",
"value",
")",
":",
"words",
"=",
"value",
".",
"split",
"(",
"\"_\"",
")",
"return",
"words",
"[",
"0",
"]",
"+",
"\"\"",
".",
"join",
"(",
"map",
"(",
"str",
".",
"capitalize",
",",
"words",
"[",
"1",
":",
"]",
... | Convert snake case string to camel case. | [
"Convert",
"snake",
"case",
"string",
"to",
"camel",
"case",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L442-L445 |
28,314 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _get_sub_prop | def _get_sub_prop(container, keys, default=None):
"""Get a nested value from a dictionary.
This method works like ``dict.get(key)``, but for nested values.
Arguments:
container (dict):
A dictionary which may contain other dictionaries as values.
keys (iterable):
A s... | python | def _get_sub_prop(container, keys, default=None):
"""Get a nested value from a dictionary.
This method works like ``dict.get(key)``, but for nested values.
Arguments:
container (dict):
A dictionary which may contain other dictionaries as values.
keys (iterable):
A s... | [
"def",
"_get_sub_prop",
"(",
"container",
",",
"keys",
",",
"default",
"=",
"None",
")",
":",
"sub_val",
"=",
"container",
"for",
"key",
"in",
"keys",
":",
"if",
"key",
"not",
"in",
"sub_val",
":",
"return",
"default",
"sub_val",
"=",
"sub_val",
"[",
"... | Get a nested value from a dictionary.
This method works like ``dict.get(key)``, but for nested values.
Arguments:
container (dict):
A dictionary which may contain other dictionaries as values.
keys (iterable):
A sequence of keys to attempt to get the value for. Each ite... | [
"Get",
"a",
"nested",
"value",
"from",
"a",
"dictionary",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L448-L490 |
28,315 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _set_sub_prop | def _set_sub_prop(container, keys, value):
"""Set a nested value in a dictionary.
Arguments:
container (dict):
A dictionary which may contain other dictionaries as values.
keys (iterable):
A sequence of keys to attempt to set the value for. Each item in
the s... | python | def _set_sub_prop(container, keys, value):
"""Set a nested value in a dictionary.
Arguments:
container (dict):
A dictionary which may contain other dictionaries as values.
keys (iterable):
A sequence of keys to attempt to set the value for. Each item in
the s... | [
"def",
"_set_sub_prop",
"(",
"container",
",",
"keys",
",",
"value",
")",
":",
"sub_val",
"=",
"container",
"for",
"key",
"in",
"keys",
"[",
":",
"-",
"1",
"]",
":",
"if",
"key",
"not",
"in",
"sub_val",
":",
"sub_val",
"[",
"key",
"]",
"=",
"{",
... | Set a nested value in a dictionary.
Arguments:
container (dict):
A dictionary which may contain other dictionaries as values.
keys (iterable):
A sequence of keys to attempt to set the value for. Each item in
the sequence represents a deeper nesting. The first key... | [
"Set",
"a",
"nested",
"value",
"in",
"a",
"dictionary",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L493-L533 |
28,316 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _del_sub_prop | def _del_sub_prop(container, keys):
"""Remove a nested key fro a dictionary.
Arguments:
container (dict):
A dictionary which may contain other dictionaries as values.
keys (iterable):
A sequence of keys to attempt to clear the value for. Each item in
the sequ... | python | def _del_sub_prop(container, keys):
"""Remove a nested key fro a dictionary.
Arguments:
container (dict):
A dictionary which may contain other dictionaries as values.
keys (iterable):
A sequence of keys to attempt to clear the value for. Each item in
the sequ... | [
"def",
"_del_sub_prop",
"(",
"container",
",",
"keys",
")",
":",
"sub_val",
"=",
"container",
"for",
"key",
"in",
"keys",
"[",
":",
"-",
"1",
"]",
":",
"if",
"key",
"not",
"in",
"sub_val",
":",
"sub_val",
"[",
"key",
"]",
"=",
"{",
"}",
"sub_val",
... | Remove a nested key fro a dictionary.
Arguments:
container (dict):
A dictionary which may contain other dictionaries as values.
keys (iterable):
A sequence of keys to attempt to clear the value for. Each item in
the sequence represents a deeper nesting. The first... | [
"Remove",
"a",
"nested",
"key",
"fro",
"a",
"dictionary",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L536-L569 |
28,317 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/_helpers.py | _build_resource_from_properties | def _build_resource_from_properties(obj, filter_fields):
"""Build a resource based on a ``_properties`` dictionary, filtered by
``filter_fields``, which follow the name of the Python object.
"""
partial = {}
for filter_field in filter_fields:
api_field = obj._PROPERTY_TO_API_FIELD.get(filter... | python | def _build_resource_from_properties(obj, filter_fields):
"""Build a resource based on a ``_properties`` dictionary, filtered by
``filter_fields``, which follow the name of the Python object.
"""
partial = {}
for filter_field in filter_fields:
api_field = obj._PROPERTY_TO_API_FIELD.get(filter... | [
"def",
"_build_resource_from_properties",
"(",
"obj",
",",
"filter_fields",
")",
":",
"partial",
"=",
"{",
"}",
"for",
"filter_field",
"in",
"filter_fields",
":",
"api_field",
"=",
"obj",
".",
"_PROPERTY_TO_API_FIELD",
".",
"get",
"(",
"filter_field",
")",
"if",... | Build a resource based on a ``_properties`` dictionary, filtered by
``filter_fields``, which follow the name of the Python object. | [
"Build",
"a",
"resource",
"based",
"on",
"a",
"_properties",
"dictionary",
"filtered",
"by",
"filter_fields",
"which",
"follow",
"the",
"name",
"of",
"the",
"Python",
"object",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/_helpers.py#L616-L632 |
28,318 | googleapis/google-cloud-python | datastore/google/cloud/datastore/key.py | _check_database_id | def _check_database_id(database_id):
"""Make sure a "Reference" database ID is empty.
:type database_id: unicode
:param database_id: The ``database_id`` field from a "Reference" protobuf.
:raises: :exc:`ValueError` if the ``database_id`` is not empty.
"""
if database_id != u"":
msg = _... | python | def _check_database_id(database_id):
"""Make sure a "Reference" database ID is empty.
:type database_id: unicode
:param database_id: The ``database_id`` field from a "Reference" protobuf.
:raises: :exc:`ValueError` if the ``database_id`` is not empty.
"""
if database_id != u"":
msg = _... | [
"def",
"_check_database_id",
"(",
"database_id",
")",
":",
"if",
"database_id",
"!=",
"u\"\"",
":",
"msg",
"=",
"_DATABASE_ID_TEMPLATE",
".",
"format",
"(",
"database_id",
")",
"raise",
"ValueError",
"(",
"msg",
")"
] | Make sure a "Reference" database ID is empty.
:type database_id: unicode
:param database_id: The ``database_id`` field from a "Reference" protobuf.
:raises: :exc:`ValueError` if the ``database_id`` is not empty. | [
"Make",
"sure",
"a",
"Reference",
"database",
"ID",
"is",
"empty",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/key.py#L549-L559 |
28,319 | googleapis/google-cloud-python | datastore/google/cloud/datastore/key.py | _add_id_or_name | def _add_id_or_name(flat_path, element_pb, empty_allowed):
"""Add the ID or name from an element to a list.
:type flat_path: list
:param flat_path: List of accumulated path parts.
:type element_pb: :class:`._app_engine_key_pb2.Path.Element`
:param element_pb: The element containing ID or name.
... | python | def _add_id_or_name(flat_path, element_pb, empty_allowed):
"""Add the ID or name from an element to a list.
:type flat_path: list
:param flat_path: List of accumulated path parts.
:type element_pb: :class:`._app_engine_key_pb2.Path.Element`
:param element_pb: The element containing ID or name.
... | [
"def",
"_add_id_or_name",
"(",
"flat_path",
",",
"element_pb",
",",
"empty_allowed",
")",
":",
"id_",
"=",
"element_pb",
".",
"id",
"name",
"=",
"element_pb",
".",
"name",
"# NOTE: Below 0 and the empty string are the \"null\" values for their",
"# respective types, i... | Add the ID or name from an element to a list.
:type flat_path: list
:param flat_path: List of accumulated path parts.
:type element_pb: :class:`._app_engine_key_pb2.Path.Element`
:param element_pb: The element containing ID or name.
:type empty_allowed: bool
:param empty_allowed: Indicates if... | [
"Add",
"the",
"ID",
"or",
"name",
"from",
"an",
"element",
"to",
"a",
"list",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/key.py#L562-L593 |
28,320 | googleapis/google-cloud-python | datastore/google/cloud/datastore/key.py | _get_flat_path | def _get_flat_path(path_pb):
"""Convert a legacy "Path" protobuf to a flat path.
For example
Element {
type: "parent"
id: 59
}
Element {
type: "child"
name: "naem"
}
would convert to ``('parent', 59, 'child', 'naem')``.
:type pa... | python | def _get_flat_path(path_pb):
"""Convert a legacy "Path" protobuf to a flat path.
For example
Element {
type: "parent"
id: 59
}
Element {
type: "child"
name: "naem"
}
would convert to ``('parent', 59, 'child', 'naem')``.
:type pa... | [
"def",
"_get_flat_path",
"(",
"path_pb",
")",
":",
"num_elts",
"=",
"len",
"(",
"path_pb",
".",
"element",
")",
"last_index",
"=",
"num_elts",
"-",
"1",
"result",
"=",
"[",
"]",
"for",
"index",
",",
"element",
"in",
"enumerate",
"(",
"path_pb",
".",
"e... | Convert a legacy "Path" protobuf to a flat path.
For example
Element {
type: "parent"
id: 59
}
Element {
type: "child"
name: "naem"
}
would convert to ``('parent', 59, 'child', 'naem')``.
:type path_pb: :class:`._app_engine_key_pb2.... | [
"Convert",
"a",
"legacy",
"Path",
"protobuf",
"to",
"a",
"flat",
"path",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/key.py#L596-L626 |
28,321 | googleapis/google-cloud-python | datastore/google/cloud/datastore/key.py | _to_legacy_path | def _to_legacy_path(dict_path):
"""Convert a tuple of ints and strings in a legacy "Path".
.. note:
This assumes, but does not verify, that each entry in
``dict_path`` is valid (i.e. doesn't have more than one
key out of "name" / "id").
:type dict_path: lsit
:param dict_path: ... | python | def _to_legacy_path(dict_path):
"""Convert a tuple of ints and strings in a legacy "Path".
.. note:
This assumes, but does not verify, that each entry in
``dict_path`` is valid (i.e. doesn't have more than one
key out of "name" / "id").
:type dict_path: lsit
:param dict_path: ... | [
"def",
"_to_legacy_path",
"(",
"dict_path",
")",
":",
"elements",
"=",
"[",
"]",
"for",
"part",
"in",
"dict_path",
":",
"element_kwargs",
"=",
"{",
"\"type\"",
":",
"part",
"[",
"\"kind\"",
"]",
"}",
"if",
"\"id\"",
"in",
"part",
":",
"element_kwargs",
"... | Convert a tuple of ints and strings in a legacy "Path".
.. note:
This assumes, but does not verify, that each entry in
``dict_path`` is valid (i.e. doesn't have more than one
key out of "name" / "id").
:type dict_path: lsit
:param dict_path: The "structured" path for a key, i.e. i... | [
"Convert",
"a",
"tuple",
"of",
"ints",
"and",
"strings",
"in",
"a",
"legacy",
"Path",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/key.py#L629-L656 |
28,322 | googleapis/google-cloud-python | datastore/google/cloud/datastore/key.py | Key._parse_path | def _parse_path(path_args):
"""Parses positional arguments into key path with kinds and IDs.
:type path_args: tuple
:param path_args: A tuple from positional arguments. Should be
alternating list of kinds (string) and ID/name
parts (int or str... | python | def _parse_path(path_args):
"""Parses positional arguments into key path with kinds and IDs.
:type path_args: tuple
:param path_args: A tuple from positional arguments. Should be
alternating list of kinds (string) and ID/name
parts (int or str... | [
"def",
"_parse_path",
"(",
"path_args",
")",
":",
"if",
"len",
"(",
"path_args",
")",
"==",
"0",
":",
"raise",
"ValueError",
"(",
"\"Key path must not be empty.\"",
")",
"kind_list",
"=",
"path_args",
"[",
":",
":",
"2",
"]",
"id_or_name_list",
"=",
"path_ar... | Parses positional arguments into key path with kinds and IDs.
:type path_args: tuple
:param path_args: A tuple from positional arguments. Should be
alternating list of kinds (string) and ID/name
parts (int or string).
:rtype: :class:`list` of... | [
"Parses",
"positional",
"arguments",
"into",
"key",
"path",
"with",
"kinds",
"and",
"IDs",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/key.py#L162-L203 |
28,323 | googleapis/google-cloud-python | datastore/google/cloud/datastore/key.py | Key._combine_args | def _combine_args(self):
"""Sets protected data by combining raw data set from the constructor.
If a ``_parent`` is set, updates the ``_flat_path`` and sets the
``_namespace`` and ``_project`` if not already set.
:rtype: :class:`list` of :class:`dict`
:returns: A list of key pa... | python | def _combine_args(self):
"""Sets protected data by combining raw data set from the constructor.
If a ``_parent`` is set, updates the ``_flat_path`` and sets the
``_namespace`` and ``_project`` if not already set.
:rtype: :class:`list` of :class:`dict`
:returns: A list of key pa... | [
"def",
"_combine_args",
"(",
"self",
")",
":",
"child_path",
"=",
"self",
".",
"_parse_path",
"(",
"self",
".",
"_flat_path",
")",
"if",
"self",
".",
"_parent",
"is",
"not",
"None",
":",
"if",
"self",
".",
"_parent",
".",
"is_partial",
":",
"raise",
"V... | Sets protected data by combining raw data set from the constructor.
If a ``_parent`` is set, updates the ``_flat_path`` and sets the
``_namespace`` and ``_project`` if not already set.
:rtype: :class:`list` of :class:`dict`
:returns: A list of key parts with kind and ID or name set.
... | [
"Sets",
"protected",
"data",
"by",
"combining",
"raw",
"data",
"set",
"from",
"the",
"constructor",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/key.py#L205-L234 |
28,324 | googleapis/google-cloud-python | datastore/google/cloud/datastore/key.py | Key._clone | def _clone(self):
"""Duplicates the Key.
Most attributes are simple types, so don't require copying. Other
attributes like ``parent`` are long-lived and so we re-use them.
:rtype: :class:`google.cloud.datastore.key.Key`
:returns: A new ``Key`` instance with the same data as the... | python | def _clone(self):
"""Duplicates the Key.
Most attributes are simple types, so don't require copying. Other
attributes like ``parent`` are long-lived and so we re-use them.
:rtype: :class:`google.cloud.datastore.key.Key`
:returns: A new ``Key`` instance with the same data as the... | [
"def",
"_clone",
"(",
"self",
")",
":",
"cloned_self",
"=",
"self",
".",
"__class__",
"(",
"*",
"self",
".",
"flat_path",
",",
"project",
"=",
"self",
".",
"project",
",",
"namespace",
"=",
"self",
".",
"namespace",
")",
"# If the current parent has already ... | Duplicates the Key.
Most attributes are simple types, so don't require copying. Other
attributes like ``parent`` are long-lived and so we re-use them.
:rtype: :class:`google.cloud.datastore.key.Key`
:returns: A new ``Key`` instance with the same data as the current one. | [
"Duplicates",
"the",
"Key",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/key.py#L236-L251 |
28,325 | googleapis/google-cloud-python | datastore/google/cloud/datastore/key.py | Key.to_protobuf | def to_protobuf(self):
"""Return a protobuf corresponding to the key.
:rtype: :class:`.entity_pb2.Key`
:returns: The protobuf representing the key.
"""
key = _entity_pb2.Key()
key.partition_id.project_id = self.project
if self.namespace:
key.partitio... | python | def to_protobuf(self):
"""Return a protobuf corresponding to the key.
:rtype: :class:`.entity_pb2.Key`
:returns: The protobuf representing the key.
"""
key = _entity_pb2.Key()
key.partition_id.project_id = self.project
if self.namespace:
key.partitio... | [
"def",
"to_protobuf",
"(",
"self",
")",
":",
"key",
"=",
"_entity_pb2",
".",
"Key",
"(",
")",
"key",
".",
"partition_id",
".",
"project_id",
"=",
"self",
".",
"project",
"if",
"self",
".",
"namespace",
":",
"key",
".",
"partition_id",
".",
"namespace_id"... | Return a protobuf corresponding to the key.
:rtype: :class:`.entity_pb2.Key`
:returns: The protobuf representing the key. | [
"Return",
"a",
"protobuf",
"corresponding",
"to",
"the",
"key",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/key.py#L280-L301 |
28,326 | googleapis/google-cloud-python | datastore/google/cloud/datastore/key.py | Key.to_legacy_urlsafe | def to_legacy_urlsafe(self, location_prefix=None):
"""Convert to a base64 encode urlsafe string for App Engine.
This is intended to work with the "legacy" representation of a
datastore "Key" used within Google App Engine (a so-called
"Reference"). The returned string can be used as the ... | python | def to_legacy_urlsafe(self, location_prefix=None):
"""Convert to a base64 encode urlsafe string for App Engine.
This is intended to work with the "legacy" representation of a
datastore "Key" used within Google App Engine (a so-called
"Reference"). The returned string can be used as the ... | [
"def",
"to_legacy_urlsafe",
"(",
"self",
",",
"location_prefix",
"=",
"None",
")",
":",
"if",
"location_prefix",
"is",
"None",
":",
"project_id",
"=",
"self",
".",
"project",
"else",
":",
"project_id",
"=",
"location_prefix",
"+",
"self",
".",
"project",
"re... | Convert to a base64 encode urlsafe string for App Engine.
This is intended to work with the "legacy" representation of a
datastore "Key" used within Google App Engine (a so-called
"Reference"). The returned string can be used as the ``urlsafe``
argument to ``ndb.Key(urlsafe=...)``. The ... | [
"Convert",
"to",
"a",
"base64",
"encode",
"urlsafe",
"string",
"for",
"App",
"Engine",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/key.py#L303-L339 |
28,327 | googleapis/google-cloud-python | datastore/google/cloud/datastore/key.py | Key._make_parent | def _make_parent(self):
"""Creates a parent key for the current path.
Extracts all but the last element in the key path and creates a new
key, while still matching the namespace and the project.
:rtype: :class:`google.cloud.datastore.key.Key` or :class:`NoneType`
:returns: A ne... | python | def _make_parent(self):
"""Creates a parent key for the current path.
Extracts all but the last element in the key path and creates a new
key, while still matching the namespace and the project.
:rtype: :class:`google.cloud.datastore.key.Key` or :class:`NoneType`
:returns: A ne... | [
"def",
"_make_parent",
"(",
"self",
")",
":",
"if",
"self",
".",
"is_partial",
":",
"parent_args",
"=",
"self",
".",
"flat_path",
"[",
":",
"-",
"1",
"]",
"else",
":",
"parent_args",
"=",
"self",
".",
"flat_path",
"[",
":",
"-",
"2",
"]",
"if",
"pa... | Creates a parent key for the current path.
Extracts all but the last element in the key path and creates a new
key, while still matching the namespace and the project.
:rtype: :class:`google.cloud.datastore.key.Key` or :class:`NoneType`
:returns: A new ``Key`` instance, whose path cons... | [
"Creates",
"a",
"parent",
"key",
"for",
"the",
"current",
"path",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/key.py#L456-L474 |
28,328 | googleapis/google-cloud-python | datastore/google/cloud/datastore/key.py | Key.parent | def parent(self):
"""The parent of the current key.
:rtype: :class:`google.cloud.datastore.key.Key` or :class:`NoneType`
:returns: A new ``Key`` instance, whose path consists of all but the
last element of current path. If the current key has only
one path el... | python | def parent(self):
"""The parent of the current key.
:rtype: :class:`google.cloud.datastore.key.Key` or :class:`NoneType`
:returns: A new ``Key`` instance, whose path consists of all but the
last element of current path. If the current key has only
one path el... | [
"def",
"parent",
"(",
"self",
")",
":",
"if",
"self",
".",
"_parent",
"is",
"None",
":",
"self",
".",
"_parent",
"=",
"self",
".",
"_make_parent",
"(",
")",
"return",
"self",
".",
"_parent"
] | The parent of the current key.
:rtype: :class:`google.cloud.datastore.key.Key` or :class:`NoneType`
:returns: A new ``Key`` instance, whose path consists of all but the
last element of current path. If the current key has only
one path element, returns ``None``. | [
"The",
"parent",
"of",
"the",
"current",
"key",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/key.py#L477-L488 |
28,329 | googleapis/google-cloud-python | logging/google/cloud/logging/handlers/transports/background_thread.py | _Worker._main_thread_terminated | def _main_thread_terminated(self):
"""Callback that attempts to send pending logs before termination."""
if not self.is_alive:
return
if not self._queue.empty():
print(
"Program shutting down, attempting to send %d queued log "
"entries to... | python | def _main_thread_terminated(self):
"""Callback that attempts to send pending logs before termination."""
if not self.is_alive:
return
if not self._queue.empty():
print(
"Program shutting down, attempting to send %d queued log "
"entries to... | [
"def",
"_main_thread_terminated",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"is_alive",
":",
"return",
"if",
"not",
"self",
".",
"_queue",
".",
"empty",
"(",
")",
":",
"print",
"(",
"\"Program shutting down, attempting to send %d queued log \"",
"\"entries ... | Callback that attempts to send pending logs before termination. | [
"Callback",
"that",
"attempts",
"to",
"send",
"pending",
"logs",
"before",
"termination",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/logging/google/cloud/logging/handlers/transports/background_thread.py#L217-L235 |
28,330 | googleapis/google-cloud-python | logging/google/cloud/logging/handlers/transports/background_thread.py | _Worker.enqueue | def enqueue(
self, record, message, resource=None, labels=None, trace=None, span_id=None
):
"""Queues a log entry to be written by the background thread.
:type record: :class:`logging.LogRecord`
:param record: Python log record that the handler was called with.
:type messag... | python | def enqueue(
self, record, message, resource=None, labels=None, trace=None, span_id=None
):
"""Queues a log entry to be written by the background thread.
:type record: :class:`logging.LogRecord`
:param record: Python log record that the handler was called with.
:type messag... | [
"def",
"enqueue",
"(",
"self",
",",
"record",
",",
"message",
",",
"resource",
"=",
"None",
",",
"labels",
"=",
"None",
",",
"trace",
"=",
"None",
",",
"span_id",
"=",
"None",
")",
":",
"self",
".",
"_queue",
".",
"put_nowait",
"(",
"{",
"\"info\"",
... | Queues a log entry to be written by the background thread.
:type record: :class:`logging.LogRecord`
:param record: Python log record that the handler was called with.
:type message: str
:param message: The message from the ``LogRecord`` after being
formatted by ... | [
"Queues",
"a",
"log",
"entry",
"to",
"be",
"written",
"by",
"the",
"background",
"thread",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/logging/google/cloud/logging/handlers/transports/background_thread.py#L237-L271 |
28,331 | googleapis/google-cloud-python | firestore/google/cloud/firestore_v1beta1/field_path.py | FieldPath.eq_or_parent | def eq_or_parent(self, other):
"""Check whether ``other`` is an ancestor.
Returns:
(bool) True IFF ``other`` is an ancestor or equal to ``self``,
else False.
"""
return self.parts[: len(other.parts)] == other.parts[: len(self.parts)] | python | def eq_or_parent(self, other):
"""Check whether ``other`` is an ancestor.
Returns:
(bool) True IFF ``other`` is an ancestor or equal to ``self``,
else False.
"""
return self.parts[: len(other.parts)] == other.parts[: len(self.parts)] | [
"def",
"eq_or_parent",
"(",
"self",
",",
"other",
")",
":",
"return",
"self",
".",
"parts",
"[",
":",
"len",
"(",
"other",
".",
"parts",
")",
"]",
"==",
"other",
".",
"parts",
"[",
":",
"len",
"(",
"self",
".",
"parts",
")",
"]"
] | Check whether ``other`` is an ancestor.
Returns:
(bool) True IFF ``other`` is an ancestor or equal to ``self``,
else False. | [
"Check",
"whether",
"other",
"is",
"an",
"ancestor",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/firestore/google/cloud/firestore_v1beta1/field_path.py#L371-L378 |
28,332 | googleapis/google-cloud-python | firestore/google/cloud/firestore_v1beta1/field_path.py | FieldPath.lineage | def lineage(self):
"""Return field paths for all parents.
Returns: Set[:class:`FieldPath`]
"""
indexes = six.moves.range(1, len(self.parts))
return {FieldPath(*self.parts[:index]) for index in indexes} | python | def lineage(self):
"""Return field paths for all parents.
Returns: Set[:class:`FieldPath`]
"""
indexes = six.moves.range(1, len(self.parts))
return {FieldPath(*self.parts[:index]) for index in indexes} | [
"def",
"lineage",
"(",
"self",
")",
":",
"indexes",
"=",
"six",
".",
"moves",
".",
"range",
"(",
"1",
",",
"len",
"(",
"self",
".",
"parts",
")",
")",
"return",
"{",
"FieldPath",
"(",
"*",
"self",
".",
"parts",
"[",
":",
"index",
"]",
")",
"for... | Return field paths for all parents.
Returns: Set[:class:`FieldPath`] | [
"Return",
"field",
"paths",
"for",
"all",
"parents",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/firestore/google/cloud/firestore_v1beta1/field_path.py#L380-L386 |
28,333 | googleapis/google-cloud-python | api_core/google/api_core/operations_v1/operations_client.py | OperationsClient.get_operation | def get_operation(
self, name, retry=gapic_v1.method.DEFAULT, timeout=gapic_v1.method.DEFAULT
):
"""Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals
as recommended by the API service.
Example:
... | python | def get_operation(
self, name, retry=gapic_v1.method.DEFAULT, timeout=gapic_v1.method.DEFAULT
):
"""Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals
as recommended by the API service.
Example:
... | [
"def",
"get_operation",
"(",
"self",
",",
"name",
",",
"retry",
"=",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
")",
":",
"request",
"=",
"operations_pb2",
".",
"GetOperationRequest",
"(",
"na... | Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals
as recommended by the API service.
Example:
>>> from google.api_core import operations_v1
>>> api = operations_v1.OperationsClient()
>>> ... | [
"Gets",
"the",
"latest",
"state",
"of",
"a",
"long",
"-",
"running",
"operation",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/api_core/google/api_core/operations_v1/operations_client.py#L93-L131 |
28,334 | googleapis/google-cloud-python | api_core/google/api_core/operations_v1/operations_client.py | OperationsClient.list_operations | def list_operations(
self,
name,
filter_,
retry=gapic_v1.method.DEFAULT,
timeout=gapic_v1.method.DEFAULT,
):
"""
Lists operations that match the specified filter in the request.
Example:
>>> from google.api_core import operations_v1
... | python | def list_operations(
self,
name,
filter_,
retry=gapic_v1.method.DEFAULT,
timeout=gapic_v1.method.DEFAULT,
):
"""
Lists operations that match the specified filter in the request.
Example:
>>> from google.api_core import operations_v1
... | [
"def",
"list_operations",
"(",
"self",
",",
"name",
",",
"filter_",
",",
"retry",
"=",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
")",
":",
"# Create the request object.",
"request",
"=",
... | Lists operations that match the specified filter in the request.
Example:
>>> from google.api_core import operations_v1
>>> api = operations_v1.OperationsClient()
>>> name = ''
>>>
>>> # Iterate over all results
>>> for operation in api.li... | [
"Lists",
"operations",
"that",
"match",
"the",
"specified",
"filter",
"in",
"the",
"request",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/api_core/google/api_core/operations_v1/operations_client.py#L133-L202 |
28,335 | googleapis/google-cloud-python | api_core/google/api_core/operations_v1/operations_client.py | OperationsClient.cancel_operation | def cancel_operation(
self, name, retry=gapic_v1.method.DEFAULT, timeout=gapic_v1.method.DEFAULT
):
"""Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is
not guaranteed. Clients can use :meth:`get_oper... | python | def cancel_operation(
self, name, retry=gapic_v1.method.DEFAULT, timeout=gapic_v1.method.DEFAULT
):
"""Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is
not guaranteed. Clients can use :meth:`get_oper... | [
"def",
"cancel_operation",
"(",
"self",
",",
"name",
",",
"retry",
"=",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
")",
":",
"# Create the request object.",
"request",
"=",
"operations_pb2",
".",
... | Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is
not guaranteed. Clients can use :meth:`get_operation` or service-
specific methods to check whether the cancellation succeeded or whether
the operation co... | [
"Starts",
"asynchronous",
"cancellation",
"on",
"a",
"long",
"-",
"running",
"operation",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/api_core/google/api_core/operations_v1/operations_client.py#L204-L248 |
28,336 | googleapis/google-cloud-python | api_core/google/api_core/operations_v1/operations_client.py | OperationsClient.delete_operation | def delete_operation(
self, name, retry=gapic_v1.method.DEFAULT, timeout=gapic_v1.method.DEFAULT
):
"""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.
Example:
... | python | def delete_operation(
self, name, retry=gapic_v1.method.DEFAULT, timeout=gapic_v1.method.DEFAULT
):
"""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.
Example:
... | [
"def",
"delete_operation",
"(",
"self",
",",
"name",
",",
"retry",
"=",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
")",
":",
"# Create the request object.",
"request",
"=",
"operations_pb2",
".",
... | 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.
Example:
>>> from google.api_core import operations_v1
>>> api = operations_v1.OperationsClient()
>>> n... | [
"Deletes",
"a",
"long",
"-",
"running",
"operation",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/api_core/google/api_core/operations_v1/operations_client.py#L250-L288 |
28,337 | googleapis/google-cloud-python | runtimeconfig/google/cloud/runtimeconfig/_helpers.py | config_name_from_full_name | def config_name_from_full_name(full_name):
"""Extract the config name from a full resource name.
>>> config_name_from_full_name('projects/my-proj/configs/my-config')
"my-config"
:type full_name: str
:param full_name:
The full resource name of a config. The full resource name looks like... | python | def config_name_from_full_name(full_name):
"""Extract the config name from a full resource name.
>>> config_name_from_full_name('projects/my-proj/configs/my-config')
"my-config"
:type full_name: str
:param full_name:
The full resource name of a config. The full resource name looks like... | [
"def",
"config_name_from_full_name",
"(",
"full_name",
")",
":",
"projects",
",",
"_",
",",
"configs",
",",
"result",
"=",
"full_name",
".",
"split",
"(",
"\"/\"",
")",
"if",
"projects",
"!=",
"\"projects\"",
"or",
"configs",
"!=",
"\"configs\"",
":",
"raise... | Extract the config name from a full resource name.
>>> config_name_from_full_name('projects/my-proj/configs/my-config')
"my-config"
:type full_name: str
:param full_name:
The full resource name of a config. The full resource name looks like
``projects/project-name/configs/config-na... | [
"Extract",
"the",
"config",
"name",
"from",
"a",
"full",
"resource",
"name",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/runtimeconfig/google/cloud/runtimeconfig/_helpers.py#L18-L42 |
28,338 | googleapis/google-cloud-python | runtimeconfig/google/cloud/runtimeconfig/_helpers.py | variable_name_from_full_name | def variable_name_from_full_name(full_name):
"""Extract the variable name from a full resource name.
>>> variable_name_from_full_name(
'projects/my-proj/configs/my-config/variables/var-name')
"var-name"
>>> variable_name_from_full_name(
'projects/my-proj/configs/my-con... | python | def variable_name_from_full_name(full_name):
"""Extract the variable name from a full resource name.
>>> variable_name_from_full_name(
'projects/my-proj/configs/my-config/variables/var-name')
"var-name"
>>> variable_name_from_full_name(
'projects/my-proj/configs/my-con... | [
"def",
"variable_name_from_full_name",
"(",
"full_name",
")",
":",
"projects",
",",
"_",
",",
"configs",
",",
"_",
",",
"variables",
",",
"result",
"=",
"full_name",
".",
"split",
"(",
"\"/\"",
",",
"5",
")",
"if",
"projects",
"!=",
"\"projects\"",
"or",
... | Extract the variable name from a full resource name.
>>> variable_name_from_full_name(
'projects/my-proj/configs/my-config/variables/var-name')
"var-name"
>>> variable_name_from_full_name(
'projects/my-proj/configs/my-config/variables/another/var/name')
"another/var/... | [
"Extract",
"the",
"variable",
"name",
"from",
"a",
"full",
"resource",
"name",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/runtimeconfig/google/cloud/runtimeconfig/_helpers.py#L45-L73 |
28,339 | googleapis/google-cloud-python | pubsub/google/cloud/pubsub_v1/subscriber/_protocol/histogram.py | Histogram.max | def max(self):
"""Return the maximum value in this histogram.
If there are no values in the histogram at all, return 600.
Returns:
int: The maximum value in the histogram.
"""
if len(self._data) == 0:
return 600
return next(iter(reversed(sorted(s... | python | def max(self):
"""Return the maximum value in this histogram.
If there are no values in the histogram at all, return 600.
Returns:
int: The maximum value in the histogram.
"""
if len(self._data) == 0:
return 600
return next(iter(reversed(sorted(s... | [
"def",
"max",
"(",
"self",
")",
":",
"if",
"len",
"(",
"self",
".",
"_data",
")",
"==",
"0",
":",
"return",
"600",
"return",
"next",
"(",
"iter",
"(",
"reversed",
"(",
"sorted",
"(",
"self",
".",
"_data",
".",
"keys",
"(",
")",
")",
")",
")",
... | Return the maximum value in this histogram.
If there are no values in the histogram at all, return 600.
Returns:
int: The maximum value in the histogram. | [
"Return",
"the",
"maximum",
"value",
"in",
"this",
"histogram",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/pubsub/google/cloud/pubsub_v1/subscriber/_protocol/histogram.py#L83-L93 |
28,340 | googleapis/google-cloud-python | pubsub/google/cloud/pubsub_v1/subscriber/_protocol/histogram.py | Histogram.min | def min(self):
"""Return the minimum value in this histogram.
If there are no values in the histogram at all, return 10.
Returns:
int: The minimum value in the histogram.
"""
if len(self._data) == 0:
return 10
return next(iter(sorted(self._data.k... | python | def min(self):
"""Return the minimum value in this histogram.
If there are no values in the histogram at all, return 10.
Returns:
int: The minimum value in the histogram.
"""
if len(self._data) == 0:
return 10
return next(iter(sorted(self._data.k... | [
"def",
"min",
"(",
"self",
")",
":",
"if",
"len",
"(",
"self",
".",
"_data",
")",
"==",
"0",
":",
"return",
"10",
"return",
"next",
"(",
"iter",
"(",
"sorted",
"(",
"self",
".",
"_data",
".",
"keys",
"(",
")",
")",
")",
")"
] | Return the minimum value in this histogram.
If there are no values in the histogram at all, return 10.
Returns:
int: The minimum value in the histogram. | [
"Return",
"the",
"minimum",
"value",
"in",
"this",
"histogram",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/pubsub/google/cloud/pubsub_v1/subscriber/_protocol/histogram.py#L96-L106 |
28,341 | googleapis/google-cloud-python | pubsub/google/cloud/pubsub_v1/subscriber/_protocol/histogram.py | Histogram.add | def add(self, value):
"""Add the value to this histogram.
Args:
value (int): The value. Values outside of ``10 <= x <= 600``
will be raised to ``10`` or reduced to ``600``.
"""
# If the value is out of bounds, bring it in bounds.
value = int(value)
... | python | def add(self, value):
"""Add the value to this histogram.
Args:
value (int): The value. Values outside of ``10 <= x <= 600``
will be raised to ``10`` or reduced to ``600``.
"""
# If the value is out of bounds, bring it in bounds.
value = int(value)
... | [
"def",
"add",
"(",
"self",
",",
"value",
")",
":",
"# If the value is out of bounds, bring it in bounds.",
"value",
"=",
"int",
"(",
"value",
")",
"if",
"value",
"<",
"10",
":",
"value",
"=",
"10",
"if",
"value",
">",
"600",
":",
"value",
"=",
"600",
"# ... | Add the value to this histogram.
Args:
value (int): The value. Values outside of ``10 <= x <= 600``
will be raised to ``10`` or reduced to ``600``. | [
"Add",
"the",
"value",
"to",
"this",
"histogram",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/pubsub/google/cloud/pubsub_v1/subscriber/_protocol/histogram.py#L108-L125 |
28,342 | googleapis/google-cloud-python | pubsub/google/cloud/pubsub_v1/subscriber/_protocol/histogram.py | Histogram.percentile | def percentile(self, percent):
"""Return the value that is the Nth precentile in the histogram.
Args:
percent (Union[int, float]): The precentile being sought. The
default consumer implementations use consistently use ``99``.
Returns:
int: The value corr... | python | def percentile(self, percent):
"""Return the value that is the Nth precentile in the histogram.
Args:
percent (Union[int, float]): The precentile being sought. The
default consumer implementations use consistently use ``99``.
Returns:
int: The value corr... | [
"def",
"percentile",
"(",
"self",
",",
"percent",
")",
":",
"# Sanity check: Any value over 100 should become 100.",
"if",
"percent",
">=",
"100",
":",
"percent",
"=",
"100",
"# Determine the actual target number.",
"target",
"=",
"len",
"(",
"self",
")",
"-",
"len"... | Return the value that is the Nth precentile in the histogram.
Args:
percent (Union[int, float]): The precentile being sought. The
default consumer implementations use consistently use ``99``.
Returns:
int: The value corresponding to the requested percentile. | [
"Return",
"the",
"value",
"that",
"is",
"the",
"Nth",
"precentile",
"in",
"the",
"histogram",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/pubsub/google/cloud/pubsub_v1/subscriber/_protocol/histogram.py#L127-L154 |
28,343 | googleapis/google-cloud-python | scheduler/google/cloud/scheduler_v1beta1/gapic/cloud_scheduler_client.py | CloudSchedulerClient.create_job | def create_job(
self,
parent,
job,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Creates a job.
Example:
>>> from google.cloud import scheduler_v1beta1
... | python | def create_job(
self,
parent,
job,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Creates a job.
Example:
>>> from google.cloud import scheduler_v1beta1
... | [
"def",
"create_job",
"(",
"self",
",",
"parent",
",",
"job",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
"... | Creates a job.
Example:
>>> from google.cloud import scheduler_v1beta1
>>>
>>> client = scheduler_v1beta1.CloudSchedulerClient()
>>>
>>> parent = client.location_path('[PROJECT]', '[LOCATION]')
>>>
>>> # TODO: Initialize `job`:... | [
"Creates",
"a",
"job",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/scheduler/google/cloud/scheduler_v1beta1/gapic/cloud_scheduler_client.py#L382-L465 |
28,344 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/model.py | ModelReference.from_string | def from_string(cls, model_id, default_project=None):
"""Construct a model reference from model ID string.
Args:
model_id (str):
A model ID in standard SQL format. If ``default_project``
is not specified, this must included a project ID, dataset
... | python | def from_string(cls, model_id, default_project=None):
"""Construct a model reference from model ID string.
Args:
model_id (str):
A model ID in standard SQL format. If ``default_project``
is not specified, this must included a project ID, dataset
... | [
"def",
"from_string",
"(",
"cls",
",",
"model_id",
",",
"default_project",
"=",
"None",
")",
":",
"proj",
",",
"dset",
",",
"model",
"=",
"_helpers",
".",
"_parse_3_part_id",
"(",
"model_id",
",",
"default_project",
"=",
"default_project",
",",
"property_name"... | Construct a model reference from model ID string.
Args:
model_id (str):
A model ID in standard SQL format. If ``default_project``
is not specified, this must included a project ID, dataset
ID, and model ID, each separated by ``.``.
default... | [
"Construct",
"a",
"model",
"reference",
"from",
"model",
"ID",
"string",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/model.py#L349-L375 |
28,345 | googleapis/google-cloud-python | tasks/google/cloud/tasks_v2beta2/gapic/cloud_tasks_client.py | CloudTasksClient.lease_tasks | def lease_tasks(
self,
parent,
lease_duration,
max_tasks=None,
response_view=None,
filter_=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Leases tasks ... | python | def lease_tasks(
self,
parent,
lease_duration,
max_tasks=None,
response_view=None,
filter_=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Leases tasks ... | [
"def",
"lease_tasks",
"(",
"self",
",",
"parent",
",",
"lease_duration",
",",
"max_tasks",
"=",
"None",
",",
"response_view",
"=",
"None",
",",
"filter_",
"=",
"None",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DE... | Leases tasks from a pull queue for ``lease_duration``.
This method is invoked by the worker to obtain a lease. The worker must
acknowledge the task via ``AcknowledgeTask`` after they have performed
the work associated with the task.
The ``payload`` is intended to store data that the wo... | [
"Leases",
"tasks",
"from",
"a",
"pull",
"queue",
"for",
"lease_duration",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/tasks/google/cloud/tasks_v2beta2/gapic/cloud_tasks_client.py#L1594-L1743 |
28,346 | googleapis/google-cloud-python | logging/google/cloud/logging/handlers/_helpers.py | format_stackdriver_json | def format_stackdriver_json(record, message):
"""Helper to format a LogRecord in in Stackdriver fluentd format.
:rtype: str
:returns: JSON str to be written to the log file.
"""
subsecond, second = math.modf(record.created)
payload = {
"message": message,
"timestamp": {... | python | def format_stackdriver_json(record, message):
"""Helper to format a LogRecord in in Stackdriver fluentd format.
:rtype: str
:returns: JSON str to be written to the log file.
"""
subsecond, second = math.modf(record.created)
payload = {
"message": message,
"timestamp": {... | [
"def",
"format_stackdriver_json",
"(",
"record",
",",
"message",
")",
":",
"subsecond",
",",
"second",
"=",
"math",
".",
"modf",
"(",
"record",
".",
"created",
")",
"payload",
"=",
"{",
"\"message\"",
":",
"message",
",",
"\"timestamp\"",
":",
"{",
"\"seco... | Helper to format a LogRecord in in Stackdriver fluentd format.
:rtype: str
:returns: JSON str to be written to the log file. | [
"Helper",
"to",
"format",
"a",
"LogRecord",
"in",
"in",
"Stackdriver",
"fluentd",
"format",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/logging/google/cloud/logging/handlers/_helpers.py#L41-L56 |
28,347 | googleapis/google-cloud-python | logging/google/cloud/logging/handlers/_helpers.py | get_trace_id_from_flask | def get_trace_id_from_flask():
"""Get trace_id from flask request headers.
:rtype: str
:returns: TraceID in HTTP request headers.
"""
if flask is None or not flask.request:
return None
header = flask.request.headers.get(_FLASK_TRACE_HEADER)
if header is None:
return None
... | python | def get_trace_id_from_flask():
"""Get trace_id from flask request headers.
:rtype: str
:returns: TraceID in HTTP request headers.
"""
if flask is None or not flask.request:
return None
header = flask.request.headers.get(_FLASK_TRACE_HEADER)
if header is None:
return None
... | [
"def",
"get_trace_id_from_flask",
"(",
")",
":",
"if",
"flask",
"is",
"None",
"or",
"not",
"flask",
".",
"request",
":",
"return",
"None",
"header",
"=",
"flask",
".",
"request",
".",
"headers",
".",
"get",
"(",
"_FLASK_TRACE_HEADER",
")",
"if",
"header",
... | Get trace_id from flask request headers.
:rtype: str
:returns: TraceID in HTTP request headers. | [
"Get",
"trace_id",
"from",
"flask",
"request",
"headers",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/logging/google/cloud/logging/handlers/_helpers.py#L59-L75 |
28,348 | googleapis/google-cloud-python | logging/google/cloud/logging/handlers/_helpers.py | get_trace_id_from_webapp2 | def get_trace_id_from_webapp2():
"""Get trace_id from webapp2 request headers.
:rtype: str
:returns: TraceID in HTTP request headers.
"""
if webapp2 is None:
return None
try:
# get_request() succeeds if we're in the middle of a webapp2
# request, or raises an assertion ... | python | def get_trace_id_from_webapp2():
"""Get trace_id from webapp2 request headers.
:rtype: str
:returns: TraceID in HTTP request headers.
"""
if webapp2 is None:
return None
try:
# get_request() succeeds if we're in the middle of a webapp2
# request, or raises an assertion ... | [
"def",
"get_trace_id_from_webapp2",
"(",
")",
":",
"if",
"webapp2",
"is",
"None",
":",
"return",
"None",
"try",
":",
"# get_request() succeeds if we're in the middle of a webapp2",
"# request, or raises an assertion error otherwise:",
"# \"Request global variable is not set\".",
"r... | Get trace_id from webapp2 request headers.
:rtype: str
:returns: TraceID in HTTP request headers. | [
"Get",
"trace_id",
"from",
"webapp2",
"request",
"headers",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/logging/google/cloud/logging/handlers/_helpers.py#L78-L102 |
28,349 | googleapis/google-cloud-python | logging/google/cloud/logging/handlers/_helpers.py | get_trace_id_from_django | def get_trace_id_from_django():
"""Get trace_id from django request headers.
:rtype: str
:returns: TraceID in HTTP request headers.
"""
request = _get_django_request()
if request is None:
return None
header = request.META.get(_DJANGO_TRACE_HEADER)
if header is None:
re... | python | def get_trace_id_from_django():
"""Get trace_id from django request headers.
:rtype: str
:returns: TraceID in HTTP request headers.
"""
request = _get_django_request()
if request is None:
return None
header = request.META.get(_DJANGO_TRACE_HEADER)
if header is None:
re... | [
"def",
"get_trace_id_from_django",
"(",
")",
":",
"request",
"=",
"_get_django_request",
"(",
")",
"if",
"request",
"is",
"None",
":",
"return",
"None",
"header",
"=",
"request",
".",
"META",
".",
"get",
"(",
"_DJANGO_TRACE_HEADER",
")",
"if",
"header",
"is"... | Get trace_id from django request headers.
:rtype: str
:returns: TraceID in HTTP request headers. | [
"Get",
"trace_id",
"from",
"django",
"request",
"headers",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/logging/google/cloud/logging/handlers/_helpers.py#L105-L122 |
28,350 | googleapis/google-cloud-python | logging/google/cloud/logging/handlers/_helpers.py | get_trace_id | def get_trace_id():
"""Helper to get trace_id from web application request header.
:rtype: str
:returns: TraceID in HTTP request headers.
"""
checkers = (
get_trace_id_from_django,
get_trace_id_from_flask,
get_trace_id_from_webapp2,
)
for checker in checkers:
... | python | def get_trace_id():
"""Helper to get trace_id from web application request header.
:rtype: str
:returns: TraceID in HTTP request headers.
"""
checkers = (
get_trace_id_from_django,
get_trace_id_from_flask,
get_trace_id_from_webapp2,
)
for checker in checkers:
... | [
"def",
"get_trace_id",
"(",
")",
":",
"checkers",
"=",
"(",
"get_trace_id_from_django",
",",
"get_trace_id_from_flask",
",",
"get_trace_id_from_webapp2",
",",
")",
"for",
"checker",
"in",
"checkers",
":",
"trace_id",
"=",
"checker",
"(",
")",
"if",
"trace_id",
"... | Helper to get trace_id from web application request header.
:rtype: str
:returns: TraceID in HTTP request headers. | [
"Helper",
"to",
"get",
"trace_id",
"from",
"web",
"application",
"request",
"header",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/logging/google/cloud/logging/handlers/_helpers.py#L125-L142 |
28,351 | googleapis/google-cloud-python | monitoring/google/cloud/monitoring_v3/gapic/group_service_client.py | GroupServiceClient.group_path | def group_path(cls, project, group):
"""Return a fully-qualified group string."""
return google.api_core.path_template.expand(
"projects/{project}/groups/{group}", project=project, group=group
) | python | def group_path(cls, project, group):
"""Return a fully-qualified group string."""
return google.api_core.path_template.expand(
"projects/{project}/groups/{group}", project=project, group=group
) | [
"def",
"group_path",
"(",
"cls",
",",
"project",
",",
"group",
")",
":",
"return",
"google",
".",
"api_core",
".",
"path_template",
".",
"expand",
"(",
"\"projects/{project}/groups/{group}\"",
",",
"project",
"=",
"project",
",",
"group",
"=",
"group",
")"
] | Return a fully-qualified group string. | [
"Return",
"a",
"fully",
"-",
"qualified",
"group",
"string",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/monitoring/google/cloud/monitoring_v3/gapic/group_service_client.py#L101-L105 |
28,352 | googleapis/google-cloud-python | monitoring/google/cloud/monitoring_v3/gapic/group_service_client.py | GroupServiceClient.list_groups | def list_groups(
self,
name,
children_of_group=None,
ancestors_of_group=None,
descendants_of_group=None,
page_size=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"... | python | def list_groups(
self,
name,
children_of_group=None,
ancestors_of_group=None,
descendants_of_group=None,
page_size=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"... | [
"def",
"list_groups",
"(",
"self",
",",
"name",
",",
"children_of_group",
"=",
"None",
",",
"ancestors_of_group",
"=",
"None",
",",
"descendants_of_group",
"=",
"None",
",",
"page_size",
"=",
"None",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_... | Lists the existing groups.
Example:
>>> from google.cloud import monitoring_v3
>>>
>>> client = monitoring_v3.GroupServiceClient()
>>>
>>> name = client.project_path('[PROJECT]')
>>>
>>> # Iterate over all results
>... | [
"Lists",
"the",
"existing",
"groups",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/monitoring/google/cloud/monitoring_v3/gapic/group_service_client.py#L206-L338 |
28,353 | googleapis/google-cloud-python | texttospeech/google/cloud/texttospeech_v1beta1/gapic/text_to_speech_client.py | TextToSpeechClient.list_voices | def list_voices(
self,
language_code=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Returns a list of ``Voice`` supported for synthesis.
Example:
>>> from google.... | python | def list_voices(
self,
language_code=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Returns a list of ``Voice`` supported for synthesis.
Example:
>>> from google.... | [
"def",
"list_voices",
"(",
"self",
",",
"language_code",
"=",
"None",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFA... | Returns a list of ``Voice`` supported for synthesis.
Example:
>>> from google.cloud import texttospeech_v1beta1
>>>
>>> client = texttospeech_v1beta1.TextToSpeechClient()
>>>
>>> response = client.list_voices()
Args:
language_code... | [
"Returns",
"a",
"list",
"of",
"Voice",
"supported",
"for",
"synthesis",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/texttospeech/google/cloud/texttospeech_v1beta1/gapic/text_to_speech_client.py#L170-L229 |
28,354 | googleapis/google-cloud-python | storage/google/cloud/storage/_signing.py | ensure_signed_credentials | def ensure_signed_credentials(credentials):
"""Raise AttributeError if the credentials are unsigned.
:type credentials: :class:`google.auth.credentials.Signing`
:param credentials: The credentials used to create a private key
for signing text.
:raises: :exc:`AttributeError` if ... | python | def ensure_signed_credentials(credentials):
"""Raise AttributeError if the credentials are unsigned.
:type credentials: :class:`google.auth.credentials.Signing`
:param credentials: The credentials used to create a private key
for signing text.
:raises: :exc:`AttributeError` if ... | [
"def",
"ensure_signed_credentials",
"(",
"credentials",
")",
":",
"if",
"not",
"isinstance",
"(",
"credentials",
",",
"google",
".",
"auth",
".",
"credentials",
".",
"Signing",
")",
":",
"auth_uri",
"=",
"(",
"\"https://google-cloud-python.readthedocs.io/en/latest/\""... | Raise AttributeError if the credentials are unsigned.
:type credentials: :class:`google.auth.credentials.Signing`
:param credentials: The credentials used to create a private key
for signing text.
:raises: :exc:`AttributeError` if credentials is not an instance
of :clas... | [
"Raise",
"AttributeError",
"if",
"the",
"credentials",
"are",
"unsigned",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/storage/google/cloud/storage/_signing.py#L34-L55 |
28,355 | googleapis/google-cloud-python | storage/google/cloud/storage/_signing.py | get_signed_query_params_v2 | def get_signed_query_params_v2(credentials, expiration, string_to_sign):
"""Gets query parameters for creating a signed URL.
:type credentials: :class:`google.auth.credentials.Signing`
:param credentials: The credentials used to create a private key
for signing text.
:type expi... | python | def get_signed_query_params_v2(credentials, expiration, string_to_sign):
"""Gets query parameters for creating a signed URL.
:type credentials: :class:`google.auth.credentials.Signing`
:param credentials: The credentials used to create a private key
for signing text.
:type expi... | [
"def",
"get_signed_query_params_v2",
"(",
"credentials",
",",
"expiration",
",",
"string_to_sign",
")",
":",
"ensure_signed_credentials",
"(",
"credentials",
")",
"signature_bytes",
"=",
"credentials",
".",
"sign_bytes",
"(",
"string_to_sign",
")",
"signature",
"=",
"... | Gets query parameters for creating a signed URL.
:type credentials: :class:`google.auth.credentials.Signing`
:param credentials: The credentials used to create a private key
for signing text.
:type expiration: int or long
:param expiration: When the signed URL should expire.
... | [
"Gets",
"query",
"parameters",
"for",
"creating",
"a",
"signed",
"URL",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/storage/google/cloud/storage/_signing.py#L58-L86 |
28,356 | googleapis/google-cloud-python | storage/google/cloud/storage/_signing.py | get_expiration_seconds_v2 | def get_expiration_seconds_v2(expiration):
"""Convert 'expiration' to a number of seconds in the future.
:type expiration: Union[Integer, datetime.datetime, datetime.timedelta]
:param expiration: Point in time when the signed URL should expire.
:raises: :exc:`TypeError` when expiration is not a valid ... | python | def get_expiration_seconds_v2(expiration):
"""Convert 'expiration' to a number of seconds in the future.
:type expiration: Union[Integer, datetime.datetime, datetime.timedelta]
:param expiration: Point in time when the signed URL should expire.
:raises: :exc:`TypeError` when expiration is not a valid ... | [
"def",
"get_expiration_seconds_v2",
"(",
"expiration",
")",
":",
"# If it's a timedelta, add it to `now` in UTC.",
"if",
"isinstance",
"(",
"expiration",
",",
"datetime",
".",
"timedelta",
")",
":",
"now",
"=",
"NOW",
"(",
")",
".",
"replace",
"(",
"tzinfo",
"=",
... | Convert 'expiration' to a number of seconds in the future.
:type expiration: Union[Integer, datetime.datetime, datetime.timedelta]
:param expiration: Point in time when the signed URL should expire.
:raises: :exc:`TypeError` when expiration is not a valid type.
:rtype: int
:returns: a timestamp a... | [
"Convert",
"expiration",
"to",
"a",
"number",
"of",
"seconds",
"in",
"the",
"future",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/storage/google/cloud/storage/_signing.py#L89-L115 |
28,357 | googleapis/google-cloud-python | storage/google/cloud/storage/_signing.py | get_expiration_seconds_v4 | def get_expiration_seconds_v4(expiration):
"""Convert 'expiration' to a number of seconds offset from the current time.
:type expiration: Union[Integer, datetime.datetime, datetime.timedelta]
:param expiration: Point in time when the signed URL should expire.
:raises: :exc:`TypeError` when expiration ... | python | def get_expiration_seconds_v4(expiration):
"""Convert 'expiration' to a number of seconds offset from the current time.
:type expiration: Union[Integer, datetime.datetime, datetime.timedelta]
:param expiration: Point in time when the signed URL should expire.
:raises: :exc:`TypeError` when expiration ... | [
"def",
"get_expiration_seconds_v4",
"(",
"expiration",
")",
":",
"if",
"not",
"isinstance",
"(",
"expiration",
",",
"_EXPIRATION_TYPES",
")",
":",
"raise",
"TypeError",
"(",
"\"Expected an integer timestamp, datetime, or \"",
"\"timedelta. Got %s\"",
"%",
"type",
"(",
"... | Convert 'expiration' to a number of seconds offset from the current time.
:type expiration: Union[Integer, datetime.datetime, datetime.timedelta]
:param expiration: Point in time when the signed URL should expire.
:raises: :exc:`TypeError` when expiration is not a valid type.
:raises: :exc:`ValueError... | [
"Convert",
"expiration",
"to",
"a",
"number",
"of",
"seconds",
"offset",
"from",
"the",
"current",
"time",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/storage/google/cloud/storage/_signing.py#L121-L160 |
28,358 | googleapis/google-cloud-python | storage/google/cloud/storage/_signing.py | get_canonical_headers | def get_canonical_headers(headers):
"""Canonicalize headers for signing.
See:
https://cloud.google.com/storage/docs/access-control/signed-urls#about-canonical-extension-headers
:type headers: Union[dict|List(Tuple(str,str))]
:param headers:
(Optional) Additional HTTP headers to be included... | python | def get_canonical_headers(headers):
"""Canonicalize headers for signing.
See:
https://cloud.google.com/storage/docs/access-control/signed-urls#about-canonical-extension-headers
:type headers: Union[dict|List(Tuple(str,str))]
:param headers:
(Optional) Additional HTTP headers to be included... | [
"def",
"get_canonical_headers",
"(",
"headers",
")",
":",
"if",
"headers",
"is",
"None",
":",
"headers",
"=",
"[",
"]",
"elif",
"isinstance",
"(",
"headers",
",",
"dict",
")",
":",
"headers",
"=",
"list",
"(",
"headers",
".",
"items",
"(",
")",
")",
... | Canonicalize headers for signing.
See:
https://cloud.google.com/storage/docs/access-control/signed-urls#about-canonical-extension-headers
:type headers: Union[dict|List(Tuple(str,str))]
:param headers:
(Optional) Additional HTTP headers to be included as part of the
signed URLs. See:
... | [
"Canonicalize",
"headers",
"for",
"signing",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/storage/google/cloud/storage/_signing.py#L163-L197 |
28,359 | googleapis/google-cloud-python | storage/google/cloud/storage/_signing.py | canonicalize | def canonicalize(method, resource, query_parameters, headers):
"""Canonicalize method, resource
:type method: str
:param method: The HTTP verb that will be used when requesting the URL.
Defaults to ``'GET'``. If method is ``'RESUMABLE'`` then the
signature will additio... | python | def canonicalize(method, resource, query_parameters, headers):
"""Canonicalize method, resource
:type method: str
:param method: The HTTP verb that will be used when requesting the URL.
Defaults to ``'GET'``. If method is ``'RESUMABLE'`` then the
signature will additio... | [
"def",
"canonicalize",
"(",
"method",
",",
"resource",
",",
"query_parameters",
",",
"headers",
")",
":",
"headers",
",",
"_",
"=",
"get_canonical_headers",
"(",
"headers",
")",
"if",
"method",
"==",
"\"RESUMABLE\"",
":",
"method",
"=",
"\"POST\"",
"headers",
... | Canonicalize method, resource
:type method: str
:param method: The HTTP verb that will be used when requesting the URL.
Defaults to ``'GET'``. If method is ``'RESUMABLE'`` then the
signature will additionally contain the `x-goog-resumable`
header, and th... | [
"Canonicalize",
"method",
"resource"
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/storage/google/cloud/storage/_signing.py#L205-L252 |
28,360 | googleapis/google-cloud-python | storage/google/cloud/storage/_signing.py | generate_signed_url_v2 | def generate_signed_url_v2(
credentials,
resource,
expiration,
api_access_endpoint="",
method="GET",
content_md5=None,
content_type=None,
response_type=None,
response_disposition=None,
generation=None,
headers=None,
query_parameters=None,
):
"""Generate a V2 signed UR... | python | def generate_signed_url_v2(
credentials,
resource,
expiration,
api_access_endpoint="",
method="GET",
content_md5=None,
content_type=None,
response_type=None,
response_disposition=None,
generation=None,
headers=None,
query_parameters=None,
):
"""Generate a V2 signed UR... | [
"def",
"generate_signed_url_v2",
"(",
"credentials",
",",
"resource",
",",
"expiration",
",",
"api_access_endpoint",
"=",
"\"\"",
",",
"method",
"=",
"\"GET\"",
",",
"content_md5",
"=",
"None",
",",
"content_type",
"=",
"None",
",",
"response_type",
"=",
"None",... | Generate a V2 signed URL to provide query-string auth'n to a resource.
.. note::
Assumes ``credentials`` implements the
:class:`google.auth.credentials.Signing` interface. Also assumes
``credentials`` has a ``service_account_email`` property which
identifies the credentials.
.... | [
"Generate",
"a",
"V2",
"signed",
"URL",
"to",
"provide",
"query",
"-",
"string",
"auth",
"n",
"to",
"a",
"resource",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/storage/google/cloud/storage/_signing.py#L255-L392 |
28,361 | googleapis/google-cloud-python | storage/google/cloud/storage/_signing.py | generate_signed_url_v4 | def generate_signed_url_v4(
credentials,
resource,
expiration,
api_access_endpoint=DEFAULT_ENDPOINT,
method="GET",
content_md5=None,
content_type=None,
response_type=None,
response_disposition=None,
generation=None,
headers=None,
query_parameters=None,
_request_timest... | python | def generate_signed_url_v4(
credentials,
resource,
expiration,
api_access_endpoint=DEFAULT_ENDPOINT,
method="GET",
content_md5=None,
content_type=None,
response_type=None,
response_disposition=None,
generation=None,
headers=None,
query_parameters=None,
_request_timest... | [
"def",
"generate_signed_url_v4",
"(",
"credentials",
",",
"resource",
",",
"expiration",
",",
"api_access_endpoint",
"=",
"DEFAULT_ENDPOINT",
",",
"method",
"=",
"\"GET\"",
",",
"content_md5",
"=",
"None",
",",
"content_type",
"=",
"None",
",",
"response_type",
"=... | Generate a V4 signed URL to provide query-string auth'n to a resource.
.. note::
Assumes ``credentials`` implements the
:class:`google.auth.credentials.Signing` interface. Also assumes
``credentials`` has a ``service_account_email`` property which
identifies the credentials.
.... | [
"Generate",
"a",
"V4",
"signed",
"URL",
"to",
"provide",
"query",
"-",
"string",
"auth",
"n",
"to",
"a",
"resource",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/storage/google/cloud/storage/_signing.py#L399-L591 |
28,362 | googleapis/google-cloud-python | translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py | TranslationServiceClient.glossary_path | def glossary_path(cls, project, location, glossary):
"""Return a fully-qualified glossary string."""
return google.api_core.path_template.expand(
"projects/{project}/locations/{location}/glossaries/{glossary}",
project=project,
location=location,
glossary=... | python | def glossary_path(cls, project, location, glossary):
"""Return a fully-qualified glossary string."""
return google.api_core.path_template.expand(
"projects/{project}/locations/{location}/glossaries/{glossary}",
project=project,
location=location,
glossary=... | [
"def",
"glossary_path",
"(",
"cls",
",",
"project",
",",
"location",
",",
"glossary",
")",
":",
"return",
"google",
".",
"api_core",
".",
"path_template",
".",
"expand",
"(",
"\"projects/{project}/locations/{location}/glossaries/{glossary}\"",
",",
"project",
"=",
"... | Return a fully-qualified glossary string. | [
"Return",
"a",
"fully",
"-",
"qualified",
"glossary",
"string",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py#L88-L95 |
28,363 | googleapis/google-cloud-python | translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py | TranslationServiceClient.translate_text | def translate_text(
self,
contents,
target_language_code,
mime_type=None,
source_language_code=None,
parent=None,
model=None,
glossary_config=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAU... | python | def translate_text(
self,
contents,
target_language_code,
mime_type=None,
source_language_code=None,
parent=None,
model=None,
glossary_config=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAU... | [
"def",
"translate_text",
"(",
"self",
",",
"contents",
",",
"target_language_code",
",",
"mime_type",
"=",
"None",
",",
"source_language_code",
"=",
"None",
",",
"parent",
"=",
"None",
",",
"model",
"=",
"None",
",",
"glossary_config",
"=",
"None",
",",
"ret... | Translates input text and returns translated text.
Example:
>>> from google.cloud import translate_v3beta1
>>>
>>> client = translate_v3beta1.TranslationServiceClient()
>>>
>>> # TODO: Initialize `contents`:
>>> contents = []
>... | [
"Translates",
"input",
"text",
"and",
"returns",
"translated",
"text",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py#L196-L317 |
28,364 | googleapis/google-cloud-python | translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py | TranslationServiceClient.detect_language | def detect_language(
self,
parent=None,
model=None,
content=None,
mime_type=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Detects the language of text within ... | python | def detect_language(
self,
parent=None,
model=None,
content=None,
mime_type=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Detects the language of text within ... | [
"def",
"detect_language",
"(",
"self",
",",
"parent",
"=",
"None",
",",
"model",
"=",
"None",
",",
"content",
"=",
"None",
",",
"mime_type",
"=",
"None",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",... | Detects the language of text within a request.
Example:
>>> from google.cloud import translate_v3beta1
>>>
>>> client = translate_v3beta1.TranslationServiceClient()
>>>
>>> response = client.detect_language()
Args:
parent (str): O... | [
"Detects",
"the",
"language",
"of",
"text",
"within",
"a",
"request",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py#L319-L404 |
28,365 | googleapis/google-cloud-python | translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py | TranslationServiceClient.get_supported_languages | def get_supported_languages(
self,
parent=None,
display_language_code=None,
model=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Returns a list of supported languages ... | python | def get_supported_languages(
self,
parent=None,
display_language_code=None,
model=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Returns a list of supported languages ... | [
"def",
"get_supported_languages",
"(",
"self",
",",
"parent",
"=",
"None",
",",
"display_language_code",
"=",
"None",
",",
"model",
"=",
"None",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"... | Returns a list of supported languages for translation.
Example:
>>> from google.cloud import translate_v3beta1
>>>
>>> client = translate_v3beta1.TranslationServiceClient()
>>>
>>> response = client.get_supported_languages()
Args:
... | [
"Returns",
"a",
"list",
"of",
"supported",
"languages",
"for",
"translation",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py#L406-L492 |
28,366 | googleapis/google-cloud-python | translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py | TranslationServiceClient.create_glossary | def create_glossary(
self,
parent,
glossary,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Creates a glossary and returns the long-running operation. Returns
NOT\_FOUND, if... | python | def create_glossary(
self,
parent,
glossary,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Creates a glossary and returns the long-running operation. Returns
NOT\_FOUND, if... | [
"def",
"create_glossary",
"(",
"self",
",",
"parent",
",",
"glossary",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEF... | Creates a glossary and returns the long-running operation. Returns
NOT\_FOUND, if the project doesn't exist.
Example:
>>> from google.cloud import translate_v3beta1
>>>
>>> client = translate_v3beta1.TranslationServiceClient()
>>>
>>> parent =... | [
"Creates",
"a",
"glossary",
"and",
"returns",
"the",
"long",
"-",
"running",
"operation",
".",
"Returns",
"NOT",
"\\",
"_FOUND",
"if",
"the",
"project",
"doesn",
"t",
"exist",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py#L646-L739 |
28,367 | googleapis/google-cloud-python | translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py | TranslationServiceClient.delete_glossary | def delete_glossary(
self,
name,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Deletes a glossary, or cancels glossary construction if the glossary
isn't created yet. Returns NOT\_... | python | def delete_glossary(
self,
name,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Deletes a glossary, or cancels glossary construction if the glossary
isn't created yet. Returns NOT\_... | [
"def",
"delete_glossary",
"(",
"self",
",",
"name",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"metada... | Deletes a glossary, or cancels glossary construction if the glossary
isn't created yet. Returns NOT\_FOUND, if the glossary doesn't exist.
Example:
>>> from google.cloud import translate_v3beta1
>>>
>>> client = translate_v3beta1.TranslationServiceClient()
... | [
"Deletes",
"a",
"glossary",
"or",
"cancels",
"glossary",
"construction",
"if",
"the",
"glossary",
"isn",
"t",
"created",
"yet",
".",
"Returns",
"NOT",
"\\",
"_FOUND",
"if",
"the",
"glossary",
"doesn",
"t",
"exist",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/translate/google/cloud/translate_v3beta1/gapic/translation_service_client.py#L916-L999 |
28,368 | googleapis/google-cloud-python | monitoring/google/cloud/monitoring_v3/_dataframe.py | _extract_header | def _extract_header(time_series):
"""Return a copy of time_series with the points removed."""
return TimeSeries(
metric=time_series.metric,
resource=time_series.resource,
metric_kind=time_series.metric_kind,
value_type=time_series.value_type,
) | python | def _extract_header(time_series):
"""Return a copy of time_series with the points removed."""
return TimeSeries(
metric=time_series.metric,
resource=time_series.resource,
metric_kind=time_series.metric_kind,
value_type=time_series.value_type,
) | [
"def",
"_extract_header",
"(",
"time_series",
")",
":",
"return",
"TimeSeries",
"(",
"metric",
"=",
"time_series",
".",
"metric",
",",
"resource",
"=",
"time_series",
".",
"resource",
",",
"metric_kind",
"=",
"time_series",
".",
"metric_kind",
",",
"value_type",... | Return a copy of time_series with the points removed. | [
"Return",
"a",
"copy",
"of",
"time_series",
"with",
"the",
"points",
"removed",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/monitoring/google/cloud/monitoring_v3/_dataframe.py#L29-L36 |
28,369 | googleapis/google-cloud-python | monitoring/google/cloud/monitoring_v3/_dataframe.py | _extract_labels | def _extract_labels(time_series):
"""Build the combined resource and metric labels, with resource_type."""
labels = {"resource_type": time_series.resource.type}
labels.update(time_series.resource.labels)
labels.update(time_series.metric.labels)
return labels | python | def _extract_labels(time_series):
"""Build the combined resource and metric labels, with resource_type."""
labels = {"resource_type": time_series.resource.type}
labels.update(time_series.resource.labels)
labels.update(time_series.metric.labels)
return labels | [
"def",
"_extract_labels",
"(",
"time_series",
")",
":",
"labels",
"=",
"{",
"\"resource_type\"",
":",
"time_series",
".",
"resource",
".",
"type",
"}",
"labels",
".",
"update",
"(",
"time_series",
".",
"resource",
".",
"labels",
")",
"labels",
".",
"update",... | Build the combined resource and metric labels, with resource_type. | [
"Build",
"the",
"combined",
"resource",
"and",
"metric",
"labels",
"with",
"resource_type",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/monitoring/google/cloud/monitoring_v3/_dataframe.py#L39-L44 |
28,370 | googleapis/google-cloud-python | monitoring/google/cloud/monitoring_v3/_dataframe.py | _sorted_resource_labels | def _sorted_resource_labels(labels):
"""Sort label names, putting well-known resource labels first."""
head = [label for label in TOP_RESOURCE_LABELS if label in labels]
tail = sorted(label for label in labels if label not in TOP_RESOURCE_LABELS)
return head + tail | python | def _sorted_resource_labels(labels):
"""Sort label names, putting well-known resource labels first."""
head = [label for label in TOP_RESOURCE_LABELS if label in labels]
tail = sorted(label for label in labels if label not in TOP_RESOURCE_LABELS)
return head + tail | [
"def",
"_sorted_resource_labels",
"(",
"labels",
")",
":",
"head",
"=",
"[",
"label",
"for",
"label",
"in",
"TOP_RESOURCE_LABELS",
"if",
"label",
"in",
"labels",
"]",
"tail",
"=",
"sorted",
"(",
"label",
"for",
"label",
"in",
"labels",
"if",
"label",
"not"... | Sort label names, putting well-known resource labels first. | [
"Sort",
"label",
"names",
"putting",
"well",
"-",
"known",
"resource",
"labels",
"first",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/monitoring/google/cloud/monitoring_v3/_dataframe.py#L143-L147 |
28,371 | googleapis/google-cloud-python | api_core/google/api_core/future/_helpers.py | start_daemon_thread | def start_daemon_thread(*args, **kwargs):
"""Starts a thread and marks it as a daemon thread."""
thread = threading.Thread(*args, **kwargs)
thread.daemon = True
thread.start()
return thread | python | def start_daemon_thread(*args, **kwargs):
"""Starts a thread and marks it as a daemon thread."""
thread = threading.Thread(*args, **kwargs)
thread.daemon = True
thread.start()
return thread | [
"def",
"start_daemon_thread",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"thread",
"=",
"threading",
".",
"Thread",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"thread",
".",
"daemon",
"=",
"True",
"thread",
".",
"start",
"(",
")",
"r... | Starts a thread and marks it as a daemon thread. | [
"Starts",
"a",
"thread",
"and",
"marks",
"it",
"as",
"a",
"daemon",
"thread",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/api_core/google/api_core/future/_helpers.py#L24-L29 |
28,372 | googleapis/google-cloud-python | api_core/google/api_core/future/_helpers.py | safe_invoke_callback | def safe_invoke_callback(callback, *args, **kwargs):
"""Invoke a callback, swallowing and logging any exceptions."""
# pylint: disable=bare-except
# We intentionally want to swallow all exceptions.
try:
return callback(*args, **kwargs)
except Exception:
_LOGGER.exception("Error while... | python | def safe_invoke_callback(callback, *args, **kwargs):
"""Invoke a callback, swallowing and logging any exceptions."""
# pylint: disable=bare-except
# We intentionally want to swallow all exceptions.
try:
return callback(*args, **kwargs)
except Exception:
_LOGGER.exception("Error while... | [
"def",
"safe_invoke_callback",
"(",
"callback",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"# pylint: disable=bare-except",
"# We intentionally want to swallow all exceptions.",
"try",
":",
"return",
"callback",
"(",
"*",
"args",
",",
"*",
"*",
"kwargs",
... | Invoke a callback, swallowing and logging any exceptions. | [
"Invoke",
"a",
"callback",
"swallowing",
"and",
"logging",
"any",
"exceptions",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/api_core/google/api_core/future/_helpers.py#L32-L39 |
28,373 | googleapis/google-cloud-python | resource_manager/google/cloud/resource_manager/client.py | Client.new_project | def new_project(self, project_id, name=None, labels=None):
"""Create a project bound to the current client.
Use :meth:`Project.reload() \
<google.cloud.resource_manager.project.Project.reload>` to retrieve
project metadata after creating a
:class:`~google.cloud.resource_manager.... | python | def new_project(self, project_id, name=None, labels=None):
"""Create a project bound to the current client.
Use :meth:`Project.reload() \
<google.cloud.resource_manager.project.Project.reload>` to retrieve
project metadata after creating a
:class:`~google.cloud.resource_manager.... | [
"def",
"new_project",
"(",
"self",
",",
"project_id",
",",
"name",
"=",
"None",
",",
"labels",
"=",
"None",
")",
":",
"return",
"Project",
"(",
"project_id",
"=",
"project_id",
",",
"client",
"=",
"self",
",",
"name",
"=",
"name",
",",
"labels",
"=",
... | Create a project bound to the current client.
Use :meth:`Project.reload() \
<google.cloud.resource_manager.project.Project.reload>` to retrieve
project metadata after creating a
:class:`~google.cloud.resource_manager.project.Project` instance.
.. note:
This does no... | [
"Create",
"a",
"project",
"bound",
"to",
"the",
"current",
"client",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/resource_manager/google/cloud/resource_manager/client.py#L61-L87 |
28,374 | googleapis/google-cloud-python | resource_manager/google/cloud/resource_manager/client.py | Client.fetch_project | def fetch_project(self, project_id):
"""Fetch an existing project and it's relevant metadata by ID.
.. note::
If the project does not exist, this will raise a
:class:`NotFound <google.cloud.exceptions.NotFound>` error.
:type project_id: str
:param project_id: T... | python | def fetch_project(self, project_id):
"""Fetch an existing project and it's relevant metadata by ID.
.. note::
If the project does not exist, this will raise a
:class:`NotFound <google.cloud.exceptions.NotFound>` error.
:type project_id: str
:param project_id: T... | [
"def",
"fetch_project",
"(",
"self",
",",
"project_id",
")",
":",
"project",
"=",
"self",
".",
"new_project",
"(",
"project_id",
")",
"project",
".",
"reload",
"(",
")",
"return",
"project"
] | Fetch an existing project and it's relevant metadata by ID.
.. note::
If the project does not exist, this will raise a
:class:`NotFound <google.cloud.exceptions.NotFound>` error.
:type project_id: str
:param project_id: The ID for this project.
:rtype: :class:... | [
"Fetch",
"an",
"existing",
"project",
"and",
"it",
"s",
"relevant",
"metadata",
"by",
"ID",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/resource_manager/google/cloud/resource_manager/client.py#L89-L106 |
28,375 | googleapis/google-cloud-python | resource_manager/google/cloud/resource_manager/client.py | Client.list_projects | def list_projects(self, filter_params=None, page_size=None):
"""List the projects visible to this client.
Example::
>>> from google.cloud import resource_manager
>>> client = resource_manager.Client()
>>> for project in client.list_projects():
... pr... | python | def list_projects(self, filter_params=None, page_size=None):
"""List the projects visible to this client.
Example::
>>> from google.cloud import resource_manager
>>> client = resource_manager.Client()
>>> for project in client.list_projects():
... pr... | [
"def",
"list_projects",
"(",
"self",
",",
"filter_params",
"=",
"None",
",",
"page_size",
"=",
"None",
")",
":",
"extra_params",
"=",
"{",
"}",
"if",
"page_size",
"is",
"not",
"None",
":",
"extra_params",
"[",
"\"pageSize\"",
"]",
"=",
"page_size",
"if",
... | List the projects visible to this client.
Example::
>>> from google.cloud import resource_manager
>>> client = resource_manager.Client()
>>> for project in client.list_projects():
... print(project.project_id)
List all projects with label ``'environ... | [
"List",
"the",
"projects",
"visible",
"to",
"this",
"client",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/resource_manager/google/cloud/resource_manager/client.py#L108-L177 |
28,376 | googleapis/google-cloud-python | spanner/google/cloud/spanner_v1/gapic/spanner_client.py | SpannerClient.execute_streaming_sql | def execute_streaming_sql(
self,
session,
sql,
transaction=None,
params=None,
param_types=None,
resume_token=None,
query_mode=None,
partition_token=None,
seqno=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=goo... | python | def execute_streaming_sql(
self,
session,
sql,
transaction=None,
params=None,
param_types=None,
resume_token=None,
query_mode=None,
partition_token=None,
seqno=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=goo... | [
"def",
"execute_streaming_sql",
"(",
"self",
",",
"session",
",",
"sql",
",",
"transaction",
"=",
"None",
",",
"params",
"=",
"None",
",",
"param_types",
"=",
"None",
",",
"resume_token",
"=",
"None",
",",
"query_mode",
"=",
"None",
",",
"partition_token",
... | Like ``ExecuteSql``, except returns the result set as a stream. Unlike
``ExecuteSql``, there is no limit on the size of the returned result
set. However, no individual row in the result set can exceed 100 MiB,
and no column value can exceed 10 MiB.
Example:
>>> from google.c... | [
"Like",
"ExecuteSql",
"except",
"returns",
"the",
"result",
"set",
"as",
"a",
"stream",
".",
"Unlike",
"ExecuteSql",
"there",
"is",
"no",
"limit",
"on",
"the",
"size",
"of",
"the",
"returned",
"result",
"set",
".",
"However",
"no",
"individual",
"row",
"in... | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/spanner/google/cloud/spanner_v1/gapic/spanner_client.py#L712-L872 |
28,377 | googleapis/google-cloud-python | spanner/google/cloud/spanner_v1/gapic/spanner_client.py | SpannerClient.execute_batch_dml | def execute_batch_dml(
self,
session,
transaction,
statements,
seqno,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Executes a batch of SQL DML statements. This met... | python | def execute_batch_dml(
self,
session,
transaction,
statements,
seqno,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Executes a batch of SQL DML statements. This met... | [
"def",
"execute_batch_dml",
"(",
"self",
",",
"session",
",",
"transaction",
",",
"statements",
",",
"seqno",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=",
"google",
".",
"api_core",
".",... | Executes a batch of SQL DML statements. This method allows many
statements to be run with lower latency than submitting them
sequentially with ``ExecuteSql``.
Statements are executed in order, sequentially.
``ExecuteBatchDmlResponse`` will contain a ``ResultSet`` for each DML
st... | [
"Executes",
"a",
"batch",
"of",
"SQL",
"DML",
"statements",
".",
"This",
"method",
"allows",
"many",
"statements",
"to",
"be",
"run",
"with",
"lower",
"latency",
"than",
"submitting",
"them",
"sequentially",
"with",
"ExecuteSql",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/spanner/google/cloud/spanner_v1/gapic/spanner_client.py#L874-L990 |
28,378 | googleapis/google-cloud-python | spanner/google/cloud/spanner_v1/gapic/spanner_client.py | SpannerClient.commit | def commit(
self,
session,
mutations,
transaction_id=None,
single_use_transaction=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Commits a transaction. The req... | python | def commit(
self,
session,
mutations,
transaction_id=None,
single_use_transaction=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Commits a transaction. The req... | [
"def",
"commit",
"(",
"self",
",",
"session",
",",
"mutations",
",",
"transaction_id",
"=",
"None",
",",
"single_use_transaction",
"=",
"None",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=... | Commits a transaction. The request includes the mutations to be applied
to rows in the database.
``Commit`` might return an ``ABORTED`` error. This can occur at any
time; commonly, the cause is conflicts with concurrent transactions.
However, it can also happen for a variety of other re... | [
"Commits",
"a",
"transaction",
".",
"The",
"request",
"includes",
"the",
"mutations",
"to",
"be",
"applied",
"to",
"rows",
"in",
"the",
"database",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/spanner/google/cloud/spanner_v1/gapic/spanner_client.py#L1352-L1460 |
28,379 | googleapis/google-cloud-python | spanner/google/cloud/spanner_v1/gapic/spanner_client.py | SpannerClient.partition_query | def partition_query(
self,
session,
sql,
transaction=None,
params=None,
param_types=None,
partition_options=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
... | python | def partition_query(
self,
session,
sql,
transaction=None,
params=None,
param_types=None,
partition_options=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
... | [
"def",
"partition_query",
"(",
"self",
",",
"session",
",",
"sql",
",",
"transaction",
"=",
"None",
",",
"params",
"=",
"None",
",",
"param_types",
"=",
"None",
",",
"partition_options",
"=",
"None",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"ga... | Creates a set of partition tokens that can be used to execute a query
operation in parallel. Each of the returned partition tokens can be used
by ``ExecuteStreamingSql`` to specify a subset of the query result to
read. The same session and read-only transaction must be used by the
Partit... | [
"Creates",
"a",
"set",
"of",
"partition",
"tokens",
"that",
"can",
"be",
"used",
"to",
"execute",
"a",
"query",
"operation",
"in",
"parallel",
".",
"Each",
"of",
"the",
"returned",
"partition",
"tokens",
"can",
"be",
"used",
"by",
"ExecuteStreamingSql",
"to"... | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/spanner/google/cloud/spanner_v1/gapic/spanner_client.py#L1541-L1679 |
28,380 | googleapis/google-cloud-python | spanner/google/cloud/spanner_v1/gapic/spanner_client.py | SpannerClient.partition_read | def partition_read(
self,
session,
table,
key_set,
transaction=None,
index=None,
columns=None,
partition_options=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
... | python | def partition_read(
self,
session,
table,
key_set,
transaction=None,
index=None,
columns=None,
partition_options=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
... | [
"def",
"partition_read",
"(",
"self",
",",
"session",
",",
"table",
",",
"key_set",
",",
"transaction",
"=",
"None",
",",
"index",
"=",
"None",
",",
"columns",
"=",
"None",
",",
"partition_options",
"=",
"None",
",",
"retry",
"=",
"google",
".",
"api_cor... | Creates a set of partition tokens that can be used to execute a read
operation in parallel. Each of the returned partition tokens can be used
by ``StreamingRead`` to specify a subset of the read result to read. The
same session and read-only transaction must be used by the
PartitionReadR... | [
"Creates",
"a",
"set",
"of",
"partition",
"tokens",
"that",
"can",
"be",
"used",
"to",
"execute",
"a",
"read",
"operation",
"in",
"parallel",
".",
"Each",
"of",
"the",
"returned",
"partition",
"tokens",
"can",
"be",
"used",
"by",
"StreamingRead",
"to",
"sp... | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/spanner/google/cloud/spanner_v1/gapic/spanner_client.py#L1681-L1806 |
28,381 | googleapis/google-cloud-python | datastore/google/cloud/datastore/_gapic.py | make_datastore_api | def make_datastore_api(client):
"""Create an instance of the GAPIC Datastore API.
:type client: :class:`~google.cloud.datastore.client.Client`
:param client: The client that holds configuration details.
:rtype: :class:`.datastore.v1.datastore_client.DatastoreClient`
:returns: A datastore API insta... | python | def make_datastore_api(client):
"""Create an instance of the GAPIC Datastore API.
:type client: :class:`~google.cloud.datastore.client.Client`
:param client: The client that holds configuration details.
:rtype: :class:`.datastore.v1.datastore_client.DatastoreClient`
:returns: A datastore API insta... | [
"def",
"make_datastore_api",
"(",
"client",
")",
":",
"parse_result",
"=",
"six",
".",
"moves",
".",
"urllib_parse",
".",
"urlparse",
"(",
"client",
".",
"_base_url",
")",
"host",
"=",
"parse_result",
".",
"netloc",
"if",
"parse_result",
".",
"scheme",
"==",... | Create an instance of the GAPIC Datastore API.
:type client: :class:`~google.cloud.datastore.client.Client`
:param client: The client that holds configuration details.
:rtype: :class:`.datastore.v1.datastore_client.DatastoreClient`
:returns: A datastore API instance with the proper credentials. | [
"Create",
"an",
"instance",
"of",
"the",
"GAPIC",
"Datastore",
"API",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/datastore/google/cloud/datastore/_gapic.py#L28-L49 |
28,382 | googleapis/google-cloud-python | bigquery/noxfile.py | snippets | def snippets(session):
"""Run the snippets test suite."""
# Sanity check: Only run snippets tests if the environment variable is set.
if not os.environ.get("GOOGLE_APPLICATION_CREDENTIALS", ""):
session.skip("Credentials must be set via environment variable.")
# Install all test dependencies, ... | python | def snippets(session):
"""Run the snippets test suite."""
# Sanity check: Only run snippets tests if the environment variable is set.
if not os.environ.get("GOOGLE_APPLICATION_CREDENTIALS", ""):
session.skip("Credentials must be set via environment variable.")
# Install all test dependencies, ... | [
"def",
"snippets",
"(",
"session",
")",
":",
"# Sanity check: Only run snippets tests if the environment variable is set.",
"if",
"not",
"os",
".",
"environ",
".",
"get",
"(",
"\"GOOGLE_APPLICATION_CREDENTIALS\"",
",",
"\"\"",
")",
":",
"session",
".",
"skip",
"(",
"\... | Run the snippets test suite. | [
"Run",
"the",
"snippets",
"test",
"suite",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/noxfile.py#L104-L121 |
28,383 | googleapis/google-cloud-python | pubsub/google/cloud/pubsub_v1/subscriber/message.py | _indent | def _indent(lines, prefix=" "):
"""Indent some text.
Note that this is present as ``textwrap.indent``, but not in Python 2.
Args:
lines (str): The newline delimited string to be indented.
prefix (Optional[str]): The prefix to indent each line with. Default
to two spaces.
... | python | def _indent(lines, prefix=" "):
"""Indent some text.
Note that this is present as ``textwrap.indent``, but not in Python 2.
Args:
lines (str): The newline delimited string to be indented.
prefix (Optional[str]): The prefix to indent each line with. Default
to two spaces.
... | [
"def",
"_indent",
"(",
"lines",
",",
"prefix",
"=",
"\" \"",
")",
":",
"indented",
"=",
"[",
"]",
"for",
"line",
"in",
"lines",
".",
"split",
"(",
"\"\\n\"",
")",
":",
"indented",
".",
"append",
"(",
"prefix",
"+",
"line",
")",
"return",
"\"\\n\"",
... | Indent some text.
Note that this is present as ``textwrap.indent``, but not in Python 2.
Args:
lines (str): The newline delimited string to be indented.
prefix (Optional[str]): The prefix to indent each line with. Default
to two spaces.
Returns:
str: The newly indented... | [
"Indent",
"some",
"text",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/pubsub/google/cloud/pubsub_v1/subscriber/message.py#L33-L49 |
28,384 | googleapis/google-cloud-python | pubsub/google/cloud/pubsub_v1/subscriber/message.py | Message.publish_time | def publish_time(self):
"""Return the time that the message was originally published.
Returns:
datetime: The date and time that the message was published.
"""
timestamp = self._message.publish_time
delta = datetime.timedelta(
seconds=timestamp.seconds, mi... | python | def publish_time(self):
"""Return the time that the message was originally published.
Returns:
datetime: The date and time that the message was published.
"""
timestamp = self._message.publish_time
delta = datetime.timedelta(
seconds=timestamp.seconds, mi... | [
"def",
"publish_time",
"(",
"self",
")",
":",
"timestamp",
"=",
"self",
".",
"_message",
".",
"publish_time",
"delta",
"=",
"datetime",
".",
"timedelta",
"(",
"seconds",
"=",
"timestamp",
".",
"seconds",
",",
"microseconds",
"=",
"timestamp",
".",
"nanos",
... | Return the time that the message was originally published.
Returns:
datetime: The date and time that the message was published. | [
"Return",
"the",
"time",
"that",
"the",
"message",
"was",
"originally",
"published",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/pubsub/google/cloud/pubsub_v1/subscriber/message.py#L147-L157 |
28,385 | googleapis/google-cloud-python | pubsub/google/cloud/pubsub_v1/subscriber/message.py | Message.ack | def ack(self):
"""Acknowledge the given message.
Acknowledging a message in Pub/Sub means that you are done
with it, and it will not be delivered to this subscription again.
You should avoid acknowledging messages until you have
*finished* processing them, so that in the event o... | python | def ack(self):
"""Acknowledge the given message.
Acknowledging a message in Pub/Sub means that you are done
with it, and it will not be delivered to this subscription again.
You should avoid acknowledging messages until you have
*finished* processing them, so that in the event o... | [
"def",
"ack",
"(",
"self",
")",
":",
"time_to_ack",
"=",
"math",
".",
"ceil",
"(",
"time",
".",
"time",
"(",
")",
"-",
"self",
".",
"_received_timestamp",
")",
"self",
".",
"_request_queue",
".",
"put",
"(",
"requests",
".",
"AckRequest",
"(",
"ack_id"... | Acknowledge the given message.
Acknowledging a message in Pub/Sub means that you are done
with it, and it will not be delivered to this subscription again.
You should avoid acknowledging messages until you have
*finished* processing them, so that in the event of a failure,
you r... | [
"Acknowledge",
"the",
"given",
"message",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/pubsub/google/cloud/pubsub_v1/subscriber/message.py#L169-L188 |
28,386 | googleapis/google-cloud-python | pubsub/google/cloud/pubsub_v1/subscriber/message.py | Message.drop | def drop(self):
"""Release the message from lease management.
This informs the policy to no longer hold on to the lease for this
message. Pub/Sub will re-deliver the message if it is not acknowledged
before the existing lease expires.
.. warning::
For most use cases... | python | def drop(self):
"""Release the message from lease management.
This informs the policy to no longer hold on to the lease for this
message. Pub/Sub will re-deliver the message if it is not acknowledged
before the existing lease expires.
.. warning::
For most use cases... | [
"def",
"drop",
"(",
"self",
")",
":",
"self",
".",
"_request_queue",
".",
"put",
"(",
"requests",
".",
"DropRequest",
"(",
"ack_id",
"=",
"self",
".",
"_ack_id",
",",
"byte_size",
"=",
"self",
".",
"size",
")",
")"
] | Release the message from lease management.
This informs the policy to no longer hold on to the lease for this
message. Pub/Sub will re-deliver the message if it is not acknowledged
before the existing lease expires.
.. warning::
For most use cases, the only reason to drop a... | [
"Release",
"the",
"message",
"from",
"lease",
"management",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/pubsub/google/cloud/pubsub_v1/subscriber/message.py#L190-L205 |
28,387 | googleapis/google-cloud-python | pubsub/google/cloud/pubsub_v1/subscriber/message.py | Message.lease | def lease(self):
"""Inform the policy to lease this message continually.
.. note::
This method is called by the constructor, and you should never
need to call it manually.
"""
self._request_queue.put(
requests.LeaseRequest(ack_id=self._ack_id, byte_si... | python | def lease(self):
"""Inform the policy to lease this message continually.
.. note::
This method is called by the constructor, and you should never
need to call it manually.
"""
self._request_queue.put(
requests.LeaseRequest(ack_id=self._ack_id, byte_si... | [
"def",
"lease",
"(",
"self",
")",
":",
"self",
".",
"_request_queue",
".",
"put",
"(",
"requests",
".",
"LeaseRequest",
"(",
"ack_id",
"=",
"self",
".",
"_ack_id",
",",
"byte_size",
"=",
"self",
".",
"size",
")",
")"
] | Inform the policy to lease this message continually.
.. note::
This method is called by the constructor, and you should never
need to call it manually. | [
"Inform",
"the",
"policy",
"to",
"lease",
"this",
"message",
"continually",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/pubsub/google/cloud/pubsub_v1/subscriber/message.py#L207-L216 |
28,388 | googleapis/google-cloud-python | pubsub/google/cloud/pubsub_v1/subscriber/message.py | Message.modify_ack_deadline | def modify_ack_deadline(self, seconds):
"""Resets the deadline for acknowledgement.
New deadline will be the given value of seconds from now.
The default implementation handles this for you; you should not need
to manually deal with setting ack deadlines. The exception case is
... | python | def modify_ack_deadline(self, seconds):
"""Resets the deadline for acknowledgement.
New deadline will be the given value of seconds from now.
The default implementation handles this for you; you should not need
to manually deal with setting ack deadlines. The exception case is
... | [
"def",
"modify_ack_deadline",
"(",
"self",
",",
"seconds",
")",
":",
"self",
".",
"_request_queue",
".",
"put",
"(",
"requests",
".",
"ModAckRequest",
"(",
"ack_id",
"=",
"self",
".",
"_ack_id",
",",
"seconds",
"=",
"seconds",
")",
")"
] | Resets the deadline for acknowledgement.
New deadline will be the given value of seconds from now.
The default implementation handles this for you; you should not need
to manually deal with setting ack deadlines. The exception case is
if you are implementing your own custom subclass of... | [
"Resets",
"the",
"deadline",
"for",
"acknowledgement",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/pubsub/google/cloud/pubsub_v1/subscriber/message.py#L218-L235 |
28,389 | googleapis/google-cloud-python | pubsub/google/cloud/pubsub_v1/subscriber/message.py | Message.nack | def nack(self):
"""Decline to acknowldge the given message.
This will cause the message to be re-delivered to the subscription.
"""
self._request_queue.put(
requests.NackRequest(ack_id=self._ack_id, byte_size=self.size)
) | python | def nack(self):
"""Decline to acknowldge the given message.
This will cause the message to be re-delivered to the subscription.
"""
self._request_queue.put(
requests.NackRequest(ack_id=self._ack_id, byte_size=self.size)
) | [
"def",
"nack",
"(",
"self",
")",
":",
"self",
".",
"_request_queue",
".",
"put",
"(",
"requests",
".",
"NackRequest",
"(",
"ack_id",
"=",
"self",
".",
"_ack_id",
",",
"byte_size",
"=",
"self",
".",
"size",
")",
")"
] | Decline to acknowldge the given message.
This will cause the message to be re-delivered to the subscription. | [
"Decline",
"to",
"acknowldge",
"the",
"given",
"message",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/pubsub/google/cloud/pubsub_v1/subscriber/message.py#L237-L244 |
28,390 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/magics.py | _run_query | def _run_query(client, query, job_config=None):
"""Runs a query while printing status updates
Args:
client (google.cloud.bigquery.client.Client):
Client to bundle configuration needed for API requests.
query (str):
SQL query to be executed. Defaults to the standard SQL d... | python | def _run_query(client, query, job_config=None):
"""Runs a query while printing status updates
Args:
client (google.cloud.bigquery.client.Client):
Client to bundle configuration needed for API requests.
query (str):
SQL query to be executed. Defaults to the standard SQL d... | [
"def",
"_run_query",
"(",
"client",
",",
"query",
",",
"job_config",
"=",
"None",
")",
":",
"start_time",
"=",
"time",
".",
"time",
"(",
")",
"query_job",
"=",
"client",
".",
"query",
"(",
"query",
",",
"job_config",
"=",
"job_config",
")",
"print",
"(... | Runs a query while printing status updates
Args:
client (google.cloud.bigquery.client.Client):
Client to bundle configuration needed for API requests.
query (str):
SQL query to be executed. Defaults to the standard SQL dialect.
Use the ``job_config`` parameter to... | [
"Runs",
"a",
"query",
"while",
"printing",
"status",
"updates"
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/magics.py#L243-L278 |
28,391 | googleapis/google-cloud-python | bigquery/google/cloud/bigquery/magics.py | _cell_magic | def _cell_magic(line, query):
"""Underlying function for bigquery cell magic
Note:
This function contains the underlying logic for the 'bigquery' cell
magic. This function is not meant to be called directly.
Args:
line (str): "%%bigquery" followed by arguments as required
q... | python | def _cell_magic(line, query):
"""Underlying function for bigquery cell magic
Note:
This function contains the underlying logic for the 'bigquery' cell
magic. This function is not meant to be called directly.
Args:
line (str): "%%bigquery" followed by arguments as required
q... | [
"def",
"_cell_magic",
"(",
"line",
",",
"query",
")",
":",
"args",
"=",
"magic_arguments",
".",
"parse_argstring",
"(",
"_cell_magic",
",",
"line",
")",
"params",
"=",
"[",
"]",
"if",
"args",
".",
"params",
"is",
"not",
"None",
":",
"try",
":",
"params... | Underlying function for bigquery cell magic
Note:
This function contains the underlying logic for the 'bigquery' cell
magic. This function is not meant to be called directly.
Args:
line (str): "%%bigquery" followed by arguments as required
query (str): SQL query to run
Ret... | [
"Underlying",
"function",
"for",
"bigquery",
"cell",
"magic"
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/bigquery/google/cloud/bigquery/magics.py#L336-L381 |
28,392 | googleapis/google-cloud-python | firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py | FirestoreClient.database_root_path | def database_root_path(cls, project, database):
"""Return a fully-qualified database_root string."""
return google.api_core.path_template.expand(
"projects/{project}/databases/{database}",
project=project,
database=database,
) | python | def database_root_path(cls, project, database):
"""Return a fully-qualified database_root string."""
return google.api_core.path_template.expand(
"projects/{project}/databases/{database}",
project=project,
database=database,
) | [
"def",
"database_root_path",
"(",
"cls",
",",
"project",
",",
"database",
")",
":",
"return",
"google",
".",
"api_core",
".",
"path_template",
".",
"expand",
"(",
"\"projects/{project}/databases/{database}\"",
",",
"project",
"=",
"project",
",",
"database",
"=",
... | Return a fully-qualified database_root string. | [
"Return",
"a",
"fully",
"-",
"qualified",
"database_root",
"string",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py#L99-L105 |
28,393 | googleapis/google-cloud-python | firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py | FirestoreClient.document_root_path | def document_root_path(cls, project, database):
"""Return a fully-qualified document_root string."""
return google.api_core.path_template.expand(
"projects/{project}/databases/{database}/documents",
project=project,
database=database,
) | python | def document_root_path(cls, project, database):
"""Return a fully-qualified document_root string."""
return google.api_core.path_template.expand(
"projects/{project}/databases/{database}/documents",
project=project,
database=database,
) | [
"def",
"document_root_path",
"(",
"cls",
",",
"project",
",",
"database",
")",
":",
"return",
"google",
".",
"api_core",
".",
"path_template",
".",
"expand",
"(",
"\"projects/{project}/databases/{database}/documents\"",
",",
"project",
"=",
"project",
",",
"database... | Return a fully-qualified document_root string. | [
"Return",
"a",
"fully",
"-",
"qualified",
"document_root",
"string",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py#L108-L114 |
28,394 | googleapis/google-cloud-python | firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py | FirestoreClient.document_path_path | def document_path_path(cls, project, database, document_path):
"""Return a fully-qualified document_path string."""
return google.api_core.path_template.expand(
"projects/{project}/databases/{database}/documents/{document_path=**}",
project=project,
database=database,... | python | def document_path_path(cls, project, database, document_path):
"""Return a fully-qualified document_path string."""
return google.api_core.path_template.expand(
"projects/{project}/databases/{database}/documents/{document_path=**}",
project=project,
database=database,... | [
"def",
"document_path_path",
"(",
"cls",
",",
"project",
",",
"database",
",",
"document_path",
")",
":",
"return",
"google",
".",
"api_core",
".",
"path_template",
".",
"expand",
"(",
"\"projects/{project}/databases/{database}/documents/{document_path=**}\"",
",",
"pro... | Return a fully-qualified document_path string. | [
"Return",
"a",
"fully",
"-",
"qualified",
"document_path",
"string",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py#L117-L124 |
28,395 | googleapis/google-cloud-python | firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py | FirestoreClient.any_path_path | def any_path_path(cls, project, database, document, any_path):
"""Return a fully-qualified any_path string."""
return google.api_core.path_template.expand(
"projects/{project}/databases/{database}/documents/{document}/{any_path=**}",
project=project,
database=database... | python | def any_path_path(cls, project, database, document, any_path):
"""Return a fully-qualified any_path string."""
return google.api_core.path_template.expand(
"projects/{project}/databases/{database}/documents/{document}/{any_path=**}",
project=project,
database=database... | [
"def",
"any_path_path",
"(",
"cls",
",",
"project",
",",
"database",
",",
"document",
",",
"any_path",
")",
":",
"return",
"google",
".",
"api_core",
".",
"path_template",
".",
"expand",
"(",
"\"projects/{project}/databases/{database}/documents/{document}/{any_path=**}\... | Return a fully-qualified any_path string. | [
"Return",
"a",
"fully",
"-",
"qualified",
"any_path",
"string",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py#L127-L135 |
28,396 | googleapis/google-cloud-python | firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py | FirestoreClient.get_document | def get_document(
self,
name,
mask=None,
transaction=None,
read_time=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Gets a single document.
Example:
... | python | def get_document(
self,
name,
mask=None,
transaction=None,
read_time=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Gets a single document.
Example:
... | [
"def",
"get_document",
"(",
"self",
",",
"name",
",",
"mask",
"=",
"None",
",",
"transaction",
"=",
"None",
",",
"read_time",
"=",
"None",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"="... | Gets a single document.
Example:
>>> from google.cloud import firestore_v1beta1
>>>
>>> client = firestore_v1beta1.FirestoreClient()
>>>
>>> name = client.any_path_path('[PROJECT]', '[DATABASE]', '[DOCUMENT]', '[ANY_PATH]')
>>>
... | [
"Gets",
"a",
"single",
"document",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py#L236-L328 |
28,397 | googleapis/google-cloud-python | firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py | FirestoreClient.list_documents | def list_documents(
self,
parent,
collection_id,
page_size=None,
order_by=None,
mask=None,
transaction=None,
read_time=None,
show_missing=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.D... | python | def list_documents(
self,
parent,
collection_id,
page_size=None,
order_by=None,
mask=None,
transaction=None,
read_time=None,
show_missing=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.D... | [
"def",
"list_documents",
"(",
"self",
",",
"parent",
",",
"collection_id",
",",
"page_size",
"=",
"None",
",",
"order_by",
"=",
"None",
",",
"mask",
"=",
"None",
",",
"transaction",
"=",
"None",
",",
"read_time",
"=",
"None",
",",
"show_missing",
"=",
"N... | Lists documents.
Example:
>>> from google.cloud import firestore_v1beta1
>>>
>>> client = firestore_v1beta1.FirestoreClient()
>>>
>>> parent = client.any_path_path('[PROJECT]', '[DATABASE]', '[DOCUMENT]', '[ANY_PATH]')
>>>
>>> ... | [
"Lists",
"documents",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py#L330-L467 |
28,398 | googleapis/google-cloud-python | firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py | FirestoreClient.update_document | def update_document(
self,
document,
update_mask,
mask=None,
current_document=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Updates or inserts a document.
... | python | def update_document(
self,
document,
update_mask,
mask=None,
current_document=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Updates or inserts a document.
... | [
"def",
"update_document",
"(",
"self",
",",
"document",
",",
"update_mask",
",",
"mask",
"=",
"None",
",",
"current_document",
"=",
"None",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
"gapic_v1",
".",
"method",
".",
"DEFAULT",
",",
"timeout",
"=",
... | Updates or inserts a document.
Example:
>>> from google.cloud import firestore_v1beta1
>>>
>>> client = firestore_v1beta1.FirestoreClient()
>>>
>>> # TODO: Initialize `document`:
>>> document = {}
>>>
>>> # TODO: In... | [
"Updates",
"or",
"inserts",
"a",
"document",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py#L562-L667 |
28,399 | googleapis/google-cloud-python | firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py | FirestoreClient.batch_get_documents | def batch_get_documents(
self,
database,
documents,
mask=None,
transaction=None,
new_transaction=None,
read_time=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
... | python | def batch_get_documents(
self,
database,
documents,
mask=None,
transaction=None,
new_transaction=None,
read_time=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
... | [
"def",
"batch_get_documents",
"(",
"self",
",",
"database",
",",
"documents",
",",
"mask",
"=",
"None",
",",
"transaction",
"=",
"None",
",",
"new_transaction",
"=",
"None",
",",
"read_time",
"=",
"None",
",",
"retry",
"=",
"google",
".",
"api_core",
".",
... | Gets multiple documents.
Documents returned by this method are not guaranteed to be returned in the
same order that they were requested.
Example:
>>> from google.cloud import firestore_v1beta1
>>>
>>> client = firestore_v1beta1.FirestoreClient()
... | [
"Gets",
"multiple",
"documents",
"."
] | 85e80125a59cb10f8cb105f25ecc099e4b940b50 | https://github.com/googleapis/google-cloud-python/blob/85e80125a59cb10f8cb105f25ecc099e4b940b50/firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py#L744-L864 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.