Blame - docs/dyn/servicemanagement_v1.services.html - platform/external/python/google-api-python-client

"sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this

1409

# message.

1410

# protobuf element, like the file in which it is defined.

1411

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1412

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1413

},

1414

"mixins": [ # Included APIs. See Mixin.

1415

{ # Declares an API to be included in this API. The including API must

1416

# redeclare all the methods from the included API, but documentation

1417

# and options are inherited as follows:

1418

#

1419

# - If after comment and whitespace stripping, the documentation

1420

# string of the redeclared method is empty, it will be inherited

1421

# from the original method.

1422

#

1423

# - Each annotation belonging to the service config (http,

1424

# visibility) which is not set in the redeclared method will be

1425

# inherited.

1426

#

1427

# - If an http annotation is inherited, the path pattern will be

1428

# modified as follows. Any version prefix will be replaced by the

1429

# version of the including API plus the root path if specified.

1430

#

1431

# Example of a simple mixin:

1432

#

1433

# package google.acl.v1;

1434

# service AccessControl {

1435

# // Get the underlying ACL object.

1436

# rpc GetAcl(GetAclRequest) returns (Acl) {

1437

# option (google.api.http).get = "/v1/{resource=**}:getAcl";

# }

# }

#

# package google.storage.v2;

1442

# service Storage {

1443

# // rpc GetAcl(GetAclRequest) returns (Acl);

1444

#

1445

# // Get a data record.

1446

# rpc GetData(GetDataRequest) returns (Data) {

1447

# option (google.api.http).get = "/v2/{resource=**}";

# }

# }

#

# Example of a mixin configuration:

1452

#

1453

# apis:

1454

# - name: google.storage.v2.Storage

1455

# mixins:

1456

# - name: google.acl.v1.AccessControl

1457

#

1458

# The mixin construct implies that all methods in `AccessControl` are

1459

# also declared with same name and request/response types in

1460

# `Storage`. A documentation generator or annotation processor will

1461

# see the effective `Storage.GetAcl` method after inherting

1462

# documentation and annotations as follows:

1463

#

1464

# service Storage {

1465

# // Get the underlying ACL object.

1466

# rpc GetAcl(GetAclRequest) returns (Acl) {

1467

# option (google.api.http).get = "/v2/{resource=**}:getAcl";

# }

# ...

# }

#

# Note how the version in the path pattern changed from `v1` to `v2`.

1473

#

1474

# If the `root` field in the mixin is specified, it should be a

1475

# relative path under which inherited HTTP paths are placed. Example:

1476

#

1477

# apis:

1478

# - name: google.storage.v2.Storage

1479

# mixins:

1480

# - name: google.acl.v1.AccessControl

1481

# root: acls

1482

#

1483

# This implies the following inherited HTTP annotation:

1484

#

1485

# service Storage {

1486

# // Get the underlying ACL object.

1487

# rpc GetAcl(GetAclRequest) returns (Acl) {

1488

# option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";

# }

# ...

# }

"root": "A String", # If non-empty specifies a path under which inherited HTTP paths

1493

# are rooted.

1494

"name": "A String", # The fully qualified name of the API which is included.

1495

},

1496

],

1497

"syntax": "A String", # The source syntax of the service.

1498

"version": "A String", # A version string for this api. If specified, must have the form

1499

# `major-version.minor-version`, as in `1.10`. If the minor version

1500

# is omitted, it defaults to zero. If the entire version field is

1501

# empty, the major version is derived from the package name, as

1502

# outlined below. If the field is not empty, the version in the

1503

# package name will be verified to be consistent with what is

1504

# provided here.

1505

#

1506

# The versioning schema uses [semantic

1507

# versioning](http://semver.org) where the major version number

1508

# indicates a breaking change and the minor version an additive,

1509

# non-breaking change. Both version numbers are signals to users

1510

# what to expect from different versions, and should be carefully

1511

# chosen based on the product plan.

1512

#

1513

# The major version is also reflected in the package name of the

1514

# API, which must end in `v<major-version>`, as in

1515

# `google.feature.v1`. For major versions 0 and 1, the suffix can

1516

# be omitted. Zero major versions must only be used for

1517

# experimental, none-GA apis.

1518

"options": [ # Any metadata attached to the API.

1519

{ # A protocol buffer option, which can be attached to a message, field,

1520

# enumeration, etc.

1521

"name": "A String", # The option's name. For example, `"java_package"`.

1522

"value": { # The option's value. For example, `"com.google.protobuf"`.

1523

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"name": "A String", # The fully qualified name of this api, including package name

1528

# followed by the api's simple name.

1529

},

1530

],

1531

"customError": { # Customize service error responses. For example, list any service # Custom error configuration.

1532

# specific protobuf types that can appear in error detail lists of

# error responses.

#

# Example:

#

# custom_error:

# types:

# - google.foo.v1.CustomError

1540

# - google.foo.v1.AnotherError

1541

"rules": [ # The list of custom error rules that apply to individual API messages.

1542

#

1543

# **NOTE:** All service configuration rules follow "last one wins" order.

1544

{ # A custom error rule.

1545

"isErrorType": True or False, # Mark this message as possible payload in error response. Otherwise,

1546

# objects of this type will be filtered when they appear in error payload.

1547

"selector": "A String", # Selects messages to which this rule applies.

1548

#

1549

# Refer to selector for syntax details.

1550

},

1551

],

1552

"types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

"A String",

],

},

"visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.

1557

# elements. Restrictions are specified using visibility labels

1558

# (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.

1559

#

1560

# Users and projects can have access to more than one visibility label. The

1561

# effective visibility for multiple labels is the union of each label's

1562

# elements, plus any unrestricted elements.

1563

#

1564

# If an element and its parents have no restrictions, visibility is

1565

# unconditionally granted.

#

# Example:

#

# visibility:

# rules:

# - selector: google.calendar.Calendar.EnhancedSearch

1572

# restriction: TRUSTED_TESTER

1573

# - selector: google.calendar.Calendar.Delegate

1574

# restriction: GOOGLE_INTERNAL

1575

#

1576

# Here, all methods are publicly visible except for the restricted methods

1577

# EnhancedSearch and Delegate.

1578

"rules": [ # A list of visibility rules that apply to individual API elements.

1579

#

1580

# **NOTE:** All service configuration rules follow "last one wins" order.

1581

{ # A visibility rule provides visibility configuration for an individual API

1582

# element.

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame^]

1583

"restriction": "A String", # A comma-separated list of visibility labels that apply to the `selector`.

1584

# Any of the listed labels can be used to grant the visibility.

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

1585

#

1586

# If a rule has multiple labels, removing one of the labels but not all of

1587

# them can break clients.

#

# Example:

#

# visibility:

# rules:

# - selector: google.calendar.Calendar.EnhancedSearch

1594

# restriction: GOOGLE_INTERNAL, TRUSTED_TESTER

1595

#

1596

# Removing GOOGLE_INTERNAL from this restriction will break clients that

1597

# rely on this method and only had access to it through GOOGLE_INTERNAL.

1598

"selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.

1599

#

1600

# Refer to selector for syntax details.

},

],

},

"metrics": [ # Defines the metrics used by this service.

1605

{ # Defines a metric type and its schema.

1606

"displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.

1607

# Use sentence case without an ending period, for example "Request count".

1608

"description": "A String", # A detailed description of the metric, which can be used in documentation.

1609

"metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame^]

1610

# Some combinations of `metric_kind` and `value_type` might not be supported.

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

1611

"valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame^]

1612

# Some combinations of `metric_kind` and `value_type` might not be supported.

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

1613

"labels": [ # The set of labels that can be used to describe a specific instance of this

1614

# metric type. For example, the

1615

# `compute.googleapis.com/instance/network/received_bytes_count` metric type

1616

# has a label, `loadbalanced`, that specifies whether the traffic was

1617

# received through a load balanced IP address.

1618

{ # A description of a label.

1619

"valueType": "A String", # The type of data that can be assigned to the label.

1620

"description": "A String", # A human-readable description for the label.

1621

"key": "A String", # The label key.

1622

},

1623

],

1624

"type": "A String", # The metric type including a DNS name prefix, for example

1625

# `"compute.googleapis.com/instance/cpu/utilization"`. Metric types

1626

# should use a natural hierarchical grouping such as the following:

1627

#

1628

# compute.googleapis.com/instance/cpu/utilization

1629

# compute.googleapis.com/instance/disk/read_ops_count

1630

# compute.googleapis.com/instance/network/received_bytes_count

1631

#

1632

# Note that if the metric type changes, the monitoring data will be

1633

# discontinued, and anything depends on it will break, such as monitoring

1634

# dashboards, alerting rules and quota limits. Therefore, once a metric has

1635

# been published, its type should be immutable.

1636

"unit": "A String", # The unit in which the metric value is reported. It is only applicable

1637

# if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The

1638

# supported units are a subset of [The Unified Code for Units of

1639

# Measure](http://unitsofmeasure.org/ucum.html) standard:

1640

#

1641

# **Basic units (UNIT)**

#

# * `bit` bit

# * `By` byte

# * `s` second

# * `min` minute

# * `h` hour

# * `d` day

#

# **Prefixes (PREFIX)**

#

# * `k` kilo (10**3)

# * `M` mega (10**6)

# * `G` giga (10**9)

# * `T` tera (10**12)

1656

# * `P` peta (10**15)

1657

# * `E` exa (10**18)

1658

# * `Z` zetta (10**21)

1659

# * `Y` yotta (10**24)

1660

# * `m` milli (10**-3)

1661

# * `u` micro (10**-6)

1662

# * `n` nano (10**-9)

1663

# * `p` pico (10**-12)

1664

# * `f` femto (10**-15)

1665

# * `a` atto (10**-18)

1666

# * `z` zepto (10**-21)

1667

# * `y` yocto (10**-24)

1668

# * `Ki` kibi (2**10)

1669

# * `Mi` mebi (2**20)

1670

# * `Gi` gibi (2**30)

1671

# * `Ti` tebi (2**40)

#

# **Grammar**

#

# The grammar includes the dimensionless unit `1`, such as `1/s`.

1676

#

1677

# The grammar also includes these connectors:

1678

#

1679

# * `/` division (as an infix operator, e.g. `1/s`).

1680

# * `.` multiplication (as an infix operator, e.g. `GBy.d`)

1681

#

1682

# The grammar for a unit is as follows:

1683

#

1684

# Expression = Component { "." Component } { "/" Component } ;

1685

#

1686

# Component = [ PREFIX ] UNIT [ Annotation ]

# | Annotation

# | "1"

# ;

#

# Annotation = "{" NAME "}" ;

#

# Notes:

#

# * `Annotation` is just a comment if it follows a `UNIT` and is

1696

# equivalent to `1` if it is used alone. For examples,

1697

# `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.

1698

# * `NAME` is a sequence of non-blank printable ASCII characters not

1699

# containing '{' or '}'.

1700

"name": "A String", # Resource name. The format of the name may vary between different

1701

# implementations. For examples:

1702

#

1703

# projects/{project_id}/metricDescriptors/{type=**}

1704

# metricDescriptors/{type=**}

1705

},

1706

],

1707

"enums": [ # A list of all enum types included in this API service. Enums

1708

# referenced directly or indirectly by the `apis` are automatically

1709

# included. Enums which are not referenced but shall be included

1710

# should be listed here by name. Example:

1711

#

1712

# enums:

1713

# - name: google.someapi.v1.SomeEnum

1714

{ # Enum type definition.

1715

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

1716

# protobuf element, like the file in which it is defined.

1717

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1718

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1719

},

1720

"enumvalue": [ # Enum value definitions.

1721

{ # Enum value definition.

1722

"number": 42, # Enum value number.

1723

"options": [ # Protocol buffer options.

1724

{ # A protocol buffer option, which can be attached to a message, field,

1725

# enumeration, etc.

1726

"name": "A String", # The option's name. For example, `"java_package"`.

1727

"value": { # The option's value. For example, `"com.google.protobuf"`.

1728

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"name": "A String", # Enum value name.

1733

},

1734

],

1735

"options": [ # Protocol buffer options.

1736

{ # A protocol buffer option, which can be attached to a message, field,

1737

# enumeration, etc.

1738

"name": "A String", # The option's name. For example, `"java_package"`.

1739

"value": { # The option's value. For example, `"com.google.protobuf"`.

1740

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"name": "A String", # Enum type name.

1745

"syntax": "A String", # The source syntax.

1746

},

1747

],

1748

"types": [ # A list of all proto message types included in this API service.

1749

# Types referenced directly or indirectly by the `apis` are

1750

# automatically included. Messages which are not referenced but

1751

# shall be included, such as types used by the `google.protobuf.Any` type,

1752

# should be listed here by name. Example:

1753

#

1754

# types:

1755

# - name: google.protobuf.Int32

1756

{ # A protocol buffer message type.

1757

"oneofs": [ # The list of types appearing in `oneof` definitions in this type.

1758

"A String",

1759

],

1760

"name": "A String", # The fully qualified message name.

1761

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

1762

# protobuf element, like the file in which it is defined.

1763

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1764

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1765

},

1766

"syntax": "A String", # The source syntax.

1767

"fields": [ # The list of fields.

1768

{ # A single field of a message type.

1769

"kind": "A String", # The field type.

1770

"oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration

1771

# types. The first type has index 1; zero means the type is not in the list.

1772

"typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration

1773

# types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

1774

"name": "A String", # The field name.

1775

"defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.

1776

"jsonName": "A String", # The field JSON name.

1777

"number": 42, # The field number.

1778

"cardinality": "A String", # The field cardinality.

1779

"options": [ # The protocol buffer options.

1780

{ # A protocol buffer option, which can be attached to a message, field,

1781

# enumeration, etc.

1782

"name": "A String", # The option's name. For example, `"java_package"`.

1783

"value": { # The option's value. For example, `"com.google.protobuf"`.

1784

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"packed": True or False, # Whether to use alternative packed wire representation.

1789

},

1790

],

1791

"options": [ # The protocol buffer options.

1792

{ # A protocol buffer option, which can be attached to a message, field,

1793

# enumeration, etc.

1794

"name": "A String", # The option's name. For example, `"java_package"`.

1795

"value": { # The option's value. For example, `"com.google.protobuf"`.

1796

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

},

],

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame^]

1802

"logging": { # Logging configuration of the service. # Logging configuration.

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

1803

#

1804

# The following example shows how to configure logs to be sent to the

1805

# producer and consumer projects. In the example,

1806

# the `library.googleapis.com/activity_history` log is

1807

# sent to both the producer and consumer projects, whereas

1808

# the `library.googleapis.com/purchase_history` log is only sent to the

1809

# producer project:

1810

#

1811

# monitored_resources:

1812

# - type: library.googleapis.com/branch

1813

# labels:

1814

# - key: /city

1815

# description: The city where the library branch is located in.

1816

# - key: /name

1817

# description: The name of the branch.

1818

# logs:

1819

# - name: library.googleapis.com/activity_history

1820

# labels:

1821

# - key: /customer_id

1822

# - name: library.googleapis.com/purchase_history

1823

# logging:

1824

# producer_destinations:

1825

# - monitored_resource: library.googleapis.com/branch

1826

# logs:

1827

# - library.googleapis.com/activity_history

1828

# - library.googleapis.com/purchase_history

1829

# consumer_destinations:

1830

# - monitored_resource: library.googleapis.com/branch

1831

# logs:

1832

# - library.googleapis.com/activity_history

1833

"producerDestinations": [ # Logging configurations for sending logs to the producer project.

1834

# There can be multiple producer destinations, each one must have a

1835

# different monitored resource type. A log can be used in at most

1836

# one producer destination.

1837

{ # Configuration of a specific logging destination (the producer project

1838

# or the consumer project).

1839

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

1840

# Service.monitored_resources section.

1841

"logs": [ # Names of the logs to be sent to this destination. Each name must

1842

# be defined in the Service.logs section.

"A String",

],

},

],

"consumerDestinations": [ # Logging configurations for sending logs to the consumer project.

1848

# There can be multiple consumer destinations, each one must have a

1849

# different monitored resource type. A log can be used in at most

1850

# one consumer destination.

1851

{ # Configuration of a specific logging destination (the producer project

1852

# or the consumer project).

1853

"monitoredResource": "A String", # The monitored resource type. The type must be defined in

1854

# Service.monitored_resources section.

1855

"logs": [ # Names of the logs to be sent to this destination. Each name must

1856

# be defined in the Service.logs section.

"A String",

],

},

],

},

"name": "A String", # The DNS address at which this service is available,

1863

# e.g. `calendar.googleapis.com`.

1864

"documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.

1865

#

1866

# Example:

1867

# <pre><code>documentation:

1868

# summary: >

1869

# The Google Calendar API gives access

1870

# to most calendar features.

1871

# pages:

1872

# - name: Overview

1873

# content: (== include google/foo/overview.md ==)

1874

# - name: Tutorial

1875

# content: (== include google/foo/tutorial.md ==)

1876

# subpages;

1877

# - name: Java

1878

# content: (== include google/foo/tutorial_java.md ==)

1879

# rules:

1880

# - selector: google.calendar.Calendar.Get

1881

# description: >

1882

# ...

1883

# - selector: google.calendar.Calendar.Put

# description: >

# ...

# </code></pre>

# Documentation is provided in markdown syntax. In addition to

1888

# standard markdown features, definition lists, tables and fenced

1889

# code blocks are supported. Section headers can be provided and are

1890

# interpreted relative to the section nesting of the context where

1891

# a documentation fragment is embedded.

1892

#

1893

# Documentation from the IDL is merged with documentation defined

1894

# via the config at normalization time, where documentation provided

1895

# by config rules overrides IDL provided.

1896

#

1897

# A number of constructs specific to the API platform are supported

1898

# in documentation text.

1899

#

1900

# In order to reference a proto element, the following

1901

# notation can be used:

1902

# <pre><code>[fully.qualified.proto.name][]</code></pre>

1903

# To override the display text used for the link, this can be used:

1904

# <pre><code>[display text][fully.qualified.proto.name]</code></pre>

1905

# Text can be excluded from doc using the following notation:

1906

# <pre><code>(-- internal comment --)</code></pre>

1907

# Comments can be made conditional using a visibility label. The below

1908

# text will be only rendered if the `BETA` label is available:

1909

# <pre><code>(--BETA: comment for BETA users --)</code></pre>

1910

# A few directives are available in documentation. Note that

1911

# directives must appear on a single line to be properly

1912

# identified. The `include` directive includes a markdown file from

1913

# an external source:

1914

# <pre><code>(== include path/to/file ==)</code></pre>

1915

# The `resource_for` directive marks a message to be the resource of

1916

# a collection in REST view. If it is not specified, tools attempt

1917

# to infer the resource from the operations in a collection:

1918

# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>

1919

# The directive `suppress_warning` does not directly affect documentation

1920

# and is documented together with service config validation.

1921

"rules": [ # A list of documentation rules that apply to individual API elements.

1922

#

1923

# **NOTE:** All service configuration rules follow "last one wins" order.

1924

{ # A documentation rule provides information about individual API elements.

1925

"description": "A String", # Description of the selected API(s).

1926

"deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an

1927

# element is marked as `deprecated`.

1928

"selector": "A String", # The selector is a comma-separated list of patterns. Each pattern is a

1929

# qualified name of the element which may end in "*", indicating a wildcard.

1930

# Wildcards are only allowed at the end and for a whole component of the

1931

# qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To

1932

# specify a default for all applicable elements, the whole pattern "*"

# is used.

},

],

"overview": "A String", # Declares a single overview page. For example:

1937

# <pre><code>documentation:

1938

# summary: ...

1939

# overview: (== include overview.md ==)

1940

# </code></pre>

1941

# This is a shortcut for the following declaration (using pages style):

1942

# <pre><code>documentation:

# summary: ...

# pages:

# - name: Overview

# content: (== include overview.md ==)

1947

# </code></pre>

1948

# Note: you cannot specify both `overview` field and `pages` field.

1949

"summary": "A String", # A short summary of what the service does. Can only be provided by

1950

# plain text.

1951

"pages": [ # The top level pages for the documentation set.

1952

{ # Represents a documentation page. A page can contain subpages to represent

1953

# nested documentation set structure.

1954

"content": "A String", # The Markdown content of the page. You can use <code>(== include {path} ==)</code>

1955

# to include content from a Markdown file.

1956

"subpages": [ # Subpages of this page. The order of subpages specified here will be

1957

# honored in the generated docset.

1958

# Object with schema name: Page

1959

],

1960

"name": "A String", # The name of the page. It will be used as an identity of the page to

1961

# generate URI of the page, text of the link to this page in navigation,

1962

# etc. The full page name (start from the root page name to this page

1963

# concatenated with `.`) can be used as reference to the page in your

1964

# documentation. For example:

1965

# <pre><code>pages:

1966

# - name: Tutorial

1967

# content: (== include tutorial.md ==)

1968

# subpages:

1969

# - name: Java

1970

# content: (== include tutorial_java.md ==)

1971

# </code></pre>

1972

# You can reference `Java` page using Markdown reference link syntax:

# `Java`.

},

],

"documentationRootUrl": "A String", # The URL to the root of documentation.

1977

},

1978

"systemTypes": [ # A list of all proto message types included in this API service.

1979

# It serves similar purpose as [google.api.Service.types], except that

1980

# these types are not needed by user-defined APIs. Therefore, they will not

1981

# show up in the generated discovery doc. This field should only be used

1982

# to define system APIs in ESF.

1983

{ # A protocol buffer message type.

1984

"oneofs": [ # The list of types appearing in `oneof` definitions in this type.

1985

"A String",

1986

],

1987

"name": "A String", # The fully qualified message name.

1988

"sourceContext": { # `SourceContext` represents information about the source of a # The source context.

1989

# protobuf element, like the file in which it is defined.

1990

"fileName": "A String", # The path-qualified name of the .proto file that contained the associated

1991

# protobuf element. For example: `"google/protobuf/source_context.proto"`.

1992

},

1993

"syntax": "A String", # The source syntax.

1994

"fields": [ # The list of fields.

1995

{ # A single field of a message type.

1996

"kind": "A String", # The field type.

1997

"oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration

1998

# types. The first type has index 1; zero means the type is not in the list.

1999

"typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration

2000

# types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.

2001

"name": "A String", # The field name.

2002

"defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.

2003

"jsonName": "A String", # The field JSON name.

2004

"number": 42, # The field number.

2005

"cardinality": "A String", # The field cardinality.

2006

"options": [ # The protocol buffer options.

2007

{ # A protocol buffer option, which can be attached to a message, field,

2008

# enumeration, etc.

2009

"name": "A String", # The option's name. For example, `"java_package"`.

2010

"value": { # The option's value. For example, `"com.google.protobuf"`.

2011

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

"packed": True or False, # Whether to use alternative packed wire representation.

2016

},

2017

],

2018

"options": [ # The protocol buffer options.

2019

{ # A protocol buffer option, which can be attached to a message, field,

2020

# enumeration, etc.

2021

"name": "A String", # The option's name. For example, `"java_package"`.

2022

"value": { # The option's value. For example, `"com.google.protobuf"`.

2023

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

},

],

},

],

"context": { # `Context` defines which contexts an API requests. # Context configuration.

#

# Example:

#

# context:

# rules:

# - selector: "*"

# requested:

# - google.rpc.context.ProjectContext

2038

# - google.rpc.context.OriginContext

2039

#

2040

# The above specifies that all methods in the API request

2041

# `google.rpc.context.ProjectContext` and

2042

# `google.rpc.context.OriginContext`.

2043

#

2044

# Available context types are defined in package

2045

# `google.rpc.context`.

2046

"rules": [ # A list of RPC context rules that apply to individual API methods.

2047

#

2048

# **NOTE:** All service configuration rules follow "last one wins" order.

2049

{ # A context rule provides information about the context for an individual API

2050

# element.

2051

"provided": [ # A list of full type names of provided contexts.

2052

"A String",

2053

],

2054

"requested": [ # A list of full type names of requested contexts.

2055

"A String",

2056

],

2057

"selector": "A String", # Selects the methods to which this rule applies.

2058

#

2059

# Refer to selector for syntax details.

2060

},

2061

],

2062

},

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame^]

2063

"endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint

2064

# with the same name as the service is automatically generated to service all

2065

# defined APIs.

2066

{ # `Endpoint` describes a network endpoint that serves a set of APIs.

2067

# A service may expose any number of endpoints, and all endpoints share the

2068

# same service configuration, such as quota configuration and monitoring

2069

# configuration.

2070

#

2071

# Example service configuration:

2072

#

2073

# name: library-example.googleapis.com

2074

# endpoints:

2075

# # Below entry makes 'google.example.library.v1.Library'

2076

# # API be served from endpoint address library-example.googleapis.com.

2077

# # It also allows HTTP OPTIONS calls to be passed to the backend, for

2078

# # it to decide whether the subsequent cross-origin request is

2079

# # allowed to proceed.

2080

# - name: library-example.googleapis.com

2081

# apis: google.example.library.v1.Library

2082

# allow_cors: true

2083

# # Below entry makes 'google.example.library.v1.Library'

2084

# # API be served from endpoint address

2085

# # google.example.library-example.v1.LibraryManager.

2086

# - name: library-manager.googleapis.com

2087

# apis: google.example.library.v1.LibraryManager

2088

# # BNS address for a borg job. Can specify a task by appending

2089

# # "/taskId" (e.g. "/0") to the job spec.

2090

#

2091

# Example OpenAPI extension for endpoint with allow_cors set to true:

#

# {

# "swagger": "2.0",

# "info": {

# "description": "A simple..."

2097

# },

2098

# "host": "MY_PROJECT_ID.appspot.com",

2099

# "x-google-endpoints": [{

2100

# "name": "MY_PROJECT_ID.appspot.com",

2101

# "allow_cors": "true"

2102

# }]

2103

# }

2104

"allowCors": True or False, # Allowing

2105

# [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka

2106

# cross-domain traffic, would allow the backends served from this endpoint to

2107

# receive and respond to HTTP OPTIONS requests. The response will be used by

2108

# the browser to determine whether the subsequent cross-origin request is

2109

# allowed to proceed.

2110

"aliases": [ # DEPRECATED: This field is no longer supported. Instead of using aliases,

2111

# please specify multiple google.api.Endpoint for each of the intented

2112

# alias.

2113

#

2114

# Additional names that this endpoint will be hosted on.

2115

"A String",

2116

],

2117

"features": [ # The list of features enabled on this endpoint.

2118

"A String",

2119

],

2120

"name": "A String", # The canonical name of this endpoint.

2121

"apis": [ # The list of APIs served by this endpoint.

"A String",

],

},

],

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</code>

2131

<pre>Gets the access control policy for a resource.

2132

Returns an empty policy if the resource exists and does not have a policy

set.

Args:

resource: string, REQUIRED: The resource for which the policy is being requested.

2137

`resource` is usually specified as a path. For example, a Project

2138

resource is specified as `projects/{project}`. (required)

2139

body: object, The request body. (required)

2140

The object takes the form of:

2141

2142

{ # Request message for `GetIamPolicy` method.

2143

}

2144

2145

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2152

2153

{ # Defines an Identity and Access Management (IAM) policy. It is used to

2154

# specify access control policies for Cloud Platform resources.

2155

#

2156

#

2157

# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of

2158

# `members` to a `role`, where the members can be user accounts, Google groups,

2159

# Google domains, and service accounts. A `role` is a named list of permissions

# defined by IAM.

#

# **Example**

#

# {

# "bindings": [

# {

# "role": "roles/owner",

2168

# "members": [

2169

# "user:mike@example.com",

2170

# "group:admins@example.com",

2171

# "domain:google.com",

2172

# "serviceAccount:my-other-app@appspot.gserviceaccount.com",

# ]

# },

# {

# "role": "roles/viewer",

2177

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

# For a description of IAM and its features, see the

2183

# [IAM developer's guide](https://cloud.google.com/iam).

2184

"auditConfigs": [ # Specifies audit logging configs for "data access".

2185

# "data access": generally refers to data reads/writes and admin reads.

2186

# "admin activity": generally refers to admin writes.

2187

#

2188

# Note: `AuditConfig` doesn't apply to "admin activity", which always

2189

# enables audit logging.

2190

{ # Enables "data access" audit logging for a service and specifies a list

2191

# of members that are log-exempted.

2192

"exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit

2193

# logging for the `service` specified above.

2194

# Follows the same format of Binding.members.

2195

"A String",

2196

],

2197

"service": "A String", # Specifies a service that will be enabled for "data access" audit

2198

# logging.

2199

# For example, `resourcemanager`, `storage`, `compute`.

2200

# `allServices` is a special value that covers all services.

2201

},

2202

],

2203

"rules": [ # If more than one rule is specified, the rules are applied in the following

2204

# manner:

2205

# - All matching LOG rules are always applied.

2206

# - If any DENY/DENY_WITH_LOG rule matches, permission is denied.

2207

# Logging will be applied if one or more matching rule requires logging.

2208

# - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is

2209

# granted.

2210

# Logging will be applied if one or more matching rule requires logging.

2211

# - Otherwise, if no rule applies, permission is denied.

2212

{ # A rule to be applied in a Policy.

2213

"notIn": [ # If one or more 'not_in' clauses are specified, the rule matches

2214

# if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2215

# The format for in and not_in entries is the same as for members in a

2216

# Binding (see google/iam/v1/policy.proto).

2217

"A String",

2218

],

2219

"description": "A String", # Human-readable description of the rule.

2220

"in": [ # If one or more 'in' clauses are specified, the rule matches if

2221

# the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2222

"A String",

2223

],

2224

"action": "A String", # Required

2225

"conditions": [ # Additional restrictions that must be met

2226

{ # A condition to be met.

2227

"iam": "A String", # Trusted attributes supplied by the IAM system.

2228

"svc": "A String", # Trusted attributes discharged by the service.

2229

"value": "A String", # DEPRECATED. Use 'values' instead.

2230

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses

2231

# the IAM system for access control.

2232

"values": [ # The objects of the condition. This is mutually exclusive with 'value'.

2233

"A String",

2234

],

2235

"op": "A String", # An operator to apply the subject with.

2236

},

2237

],

2238

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries

2239

# that match the LOG action.

2240

{ # Specifies what kind of log the caller must write

2241

# Increment a streamz counter with the specified metric and field names.

2242

#

2243

# Metric names should start with a '/', generally be lowercase-only,

2244

# and end in "_count". Field names should not contain an initial slash.

2245

# The actual exported metric names will have "/iam/policy" prepended.

2246

#

2247

# Field names correspond to IAM request parameters and field values are

2248

# their respective values.

2249

#

2250

# At present the only supported field names are

2251

# - "iam_principal", corresponding to IAMContext.principal;

2252

# - "" (empty string), resulting in one aggretated counter with no field.

2253

#

2254

# Examples:

2255

# counter { metric: "/debug_access_count" field: "iam_principal" }

2256

# ==> increment counter /iam/policy/backend_debug_access_count

2257

# {iam_principal=[value of IAMContext.principal]}

2258

#

2259

# At this time we do not support:

2260

# * multiple field names (though this may be supported in the future)

2261

# * decrementing the counter

2262

# * incrementing it by anything other than 1

2263

"counter": { # Options for counters # Counter options.

2264

"field": "A String", # The field value to attribute.

2265

"metric": "A String", # The metric to update.

2266

},

2267

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2268

},

2269

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

},

},

],

"permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'

2274

# (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,

2275

# and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Version of the `Policy`. The default version is 0.

2281

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2282

# prevent simultaneous updates of a policy from overwriting each other.

2283

# It is strongly suggested that systems make use of the `etag` in the

2284

# read-modify-write cycle to perform policy updates in order to avoid race

2285

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2286

# systems are expected to put that etag in the request to `setIamPolicy` to

2287

# ensure that their change will be applied to the same version of the policy.

2288

#

2289

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

2290

# policy is overwritten blindly.

2291

"bindings": [ # Associates a list of `members` to a `role`.

2292

# Multiple `bindings` must not be specified for the same `role`.

2293

# `bindings` with no members will result in an error.

2294

{ # Associates `members` with a `role`.

2295

"role": "A String", # Role that is assigned to `members`.

2296

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2297

# Required

2298

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

2299

# `members` can have the following values:

2300

#

2301

# * `allUsers`: A special identifier that represents anyone who is

2302

# on the internet; with or without a Google account.

2303

#

2304

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2305

# who is authenticated with a Google account or a service account.

2306

#

2307

# * `user:{emailid}`: An email address that represents a specific Google

2308

# account. For example, `alice@gmail.com` or `joe@example.com`.

2309

#

2310

# * `serviceAccount:{emailid}`: An email address that represents a service

2311

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2312

#

2313

# * `group:{emailid}`: An email address that represents a Google group.

2314

# For example, `admins@example.com`.

2315

#

2316

# * `domain:{domain}`: A Google Apps domain name that represents all the

2317

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

},

],

"iamOwned": True or False,

}</pre>

</div>

<code class="details" id="list">list(producerProjectId=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

2329

<pre>Lists all managed services.

2330

2331

Args:

2332

producerProjectId: string, Include services produced by the specified project.

2333

pageSize: integer, Requested size of the next page of data.

2334

pageToken: string, Token identifying which result to start with; returned by a previous list

2335

call.

2336

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2343

2344

{ # Response message for `ListServices` method.

2345

"nextPageToken": "A String", # Token that can be passed to `ListServices` to resume a paginated query.

2346

"services": [ # The results of the query.

2347

{ # The full representation of a Service that is managed by

2348

# Google Service Management.

2349

"serviceName": "A String", # The name of the service. See the [overview](/service-management/overview)

2350

# for naming requirements.

2351

"producerProjectId": "A String", # ID of the project that produces and owns this service.

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2359

<pre>Retrieves the next page of results.

2360

2361

Args:

2362

previous_request: The request for the previous page. (required)

2363

previous_response: The response from the request for the previous page. (required)

2364

2365

Returns:

2366

A request object that you can call 'execute()' on to request the next

2367

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code>

2373

<pre>Sets the access control policy on the specified resource. Replaces any

existing policy.

Args:

resource: string, REQUIRED: The resource for which the policy is being specified.

2378

`resource` is usually specified as a path. For example, a Project

2379

resource is specified as `projects/{project}`. (required)

2380

body: object, The request body. (required)

2381

The object takes the form of:

2382

2383

{ # Request message for `SetIamPolicy` method.

2384

"policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of

2385

# the policy is limited to a few 10s of KB. An empty policy is a

2386

# valid policy but certain Cloud Platform services (such as Projects)

2387

# might reject them.

2388

# specify access control policies for Cloud Platform resources.

2389

#

2390

#

2391

# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of

2392

# `members` to a `role`, where the members can be user accounts, Google groups,

2393

# Google domains, and service accounts. A `role` is a named list of permissions

# defined by IAM.

#

# **Example**

#

# {

# "bindings": [

# {

# "role": "roles/owner",

2402

# "members": [

2403

# "user:mike@example.com",

2404

# "group:admins@example.com",

2405

# "domain:google.com",

2406

# "serviceAccount:my-other-app@appspot.gserviceaccount.com",

# ]

# },

# {

# "role": "roles/viewer",

2411

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

# For a description of IAM and its features, see the

2417

# [IAM developer's guide](https://cloud.google.com/iam).

2418

"auditConfigs": [ # Specifies audit logging configs for "data access".

2419

# "data access": generally refers to data reads/writes and admin reads.

2420

# "admin activity": generally refers to admin writes.

2421

#

2422

# Note: `AuditConfig` doesn't apply to "admin activity", which always

2423

# enables audit logging.

2424

{ # Enables "data access" audit logging for a service and specifies a list

2425

# of members that are log-exempted.

2426

"exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit

2427

# logging for the `service` specified above.

2428

# Follows the same format of Binding.members.

2429

"A String",

2430

],

2431

"service": "A String", # Specifies a service that will be enabled for "data access" audit

2432

# logging.

2433

# For example, `resourcemanager`, `storage`, `compute`.

2434

# `allServices` is a special value that covers all services.

2435

},

2436

],

2437

"rules": [ # If more than one rule is specified, the rules are applied in the following

2438

# manner:

2439

# - All matching LOG rules are always applied.

2440

# - If any DENY/DENY_WITH_LOG rule matches, permission is denied.

2441

# Logging will be applied if one or more matching rule requires logging.

2442

# - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is

2443

# granted.

2444

# Logging will be applied if one or more matching rule requires logging.

2445

# - Otherwise, if no rule applies, permission is denied.

2446

{ # A rule to be applied in a Policy.

2447

"notIn": [ # If one or more 'not_in' clauses are specified, the rule matches

2448

# if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2449

# The format for in and not_in entries is the same as for members in a

2450

# Binding (see google/iam/v1/policy.proto).

2451

"A String",

2452

],

2453

"description": "A String", # Human-readable description of the rule.

2454

"in": [ # If one or more 'in' clauses are specified, the rule matches if

2455

# the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2456

"A String",

2457

],

2458

"action": "A String", # Required

2459

"conditions": [ # Additional restrictions that must be met

2460

{ # A condition to be met.

2461

"iam": "A String", # Trusted attributes supplied by the IAM system.

2462

"svc": "A String", # Trusted attributes discharged by the service.

2463

"value": "A String", # DEPRECATED. Use 'values' instead.

2464

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses

2465

# the IAM system for access control.

2466

"values": [ # The objects of the condition. This is mutually exclusive with 'value'.

2467

"A String",

2468

],

2469

"op": "A String", # An operator to apply the subject with.

2470

},

2471

],

2472

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries

2473

# that match the LOG action.

2474

{ # Specifies what kind of log the caller must write

2475

# Increment a streamz counter with the specified metric and field names.

2476

#

2477

# Metric names should start with a '/', generally be lowercase-only,

2478

# and end in "_count". Field names should not contain an initial slash.

2479

# The actual exported metric names will have "/iam/policy" prepended.

2480

#

2481

# Field names correspond to IAM request parameters and field values are

2482

# their respective values.

2483

#

2484

# At present the only supported field names are

2485

# - "iam_principal", corresponding to IAMContext.principal;

2486

# - "" (empty string), resulting in one aggretated counter with no field.

2487

#

2488

# Examples:

2489

# counter { metric: "/debug_access_count" field: "iam_principal" }

2490

# ==> increment counter /iam/policy/backend_debug_access_count

2491

# {iam_principal=[value of IAMContext.principal]}

2492

#

2493

# At this time we do not support:

2494

# * multiple field names (though this may be supported in the future)

2495

# * decrementing the counter

2496

# * incrementing it by anything other than 1

2497

"counter": { # Options for counters # Counter options.

2498

"field": "A String", # The field value to attribute.

2499

"metric": "A String", # The metric to update.

2500

},

2501

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2502

},

2503

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

},

},

],

"permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'

2508

# (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,

2509

# and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Version of the `Policy`. The default version is 0.

2515

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2516

# prevent simultaneous updates of a policy from overwriting each other.

2517

# It is strongly suggested that systems make use of the `etag` in the

2518

# read-modify-write cycle to perform policy updates in order to avoid race

2519

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2520

# systems are expected to put that etag in the request to `setIamPolicy` to

2521

# ensure that their change will be applied to the same version of the policy.

2522

#

2523

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

2524

# policy is overwritten blindly.

2525

"bindings": [ # Associates a list of `members` to a `role`.

2526

# Multiple `bindings` must not be specified for the same `role`.

2527

# `bindings` with no members will result in an error.

2528

{ # Associates `members` with a `role`.

2529

"role": "A String", # Role that is assigned to `members`.

2530

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2531

# Required

2532

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

2533

# `members` can have the following values:

2534

#

2535

# * `allUsers`: A special identifier that represents anyone who is

2536

# on the internet; with or without a Google account.

2537

#

2538

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2539

# who is authenticated with a Google account or a service account.

2540

#

2541

# * `user:{emailid}`: An email address that represents a specific Google

2542

# account. For example, `alice@gmail.com` or `joe@example.com`.

2543

#

2544

# * `serviceAccount:{emailid}`: An email address that represents a service

2545

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2546

#

2547

# * `group:{emailid}`: An email address that represents a Google group.

2548

# For example, `admins@example.com`.

2549

#

2550

# * `domain:{domain}`: A Google Apps domain name that represents all the

2551

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

},

],

"iamOwned": True or False,

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2568

2569

{ # Defines an Identity and Access Management (IAM) policy. It is used to

2570

# specify access control policies for Cloud Platform resources.

2571

#

2572

#

2573

# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of

2574

# `members` to a `role`, where the members can be user accounts, Google groups,

2575

# Google domains, and service accounts. A `role` is a named list of permissions

# defined by IAM.

#

# **Example**

#

# {

# "bindings": [

# {

# "role": "roles/owner",

2584

# "members": [

2585

# "user:mike@example.com",

2586

# "group:admins@example.com",

2587

# "domain:google.com",

2588

# "serviceAccount:my-other-app@appspot.gserviceaccount.com",

# ]

# },

# {

# "role": "roles/viewer",

2593

# "members": ["user:sean@example.com"]

# }

# ]

# }

#

# For a description of IAM and its features, see the

2599

# [IAM developer's guide](https://cloud.google.com/iam).

2600

"auditConfigs": [ # Specifies audit logging configs for "data access".

2601

# "data access": generally refers to data reads/writes and admin reads.

2602

# "admin activity": generally refers to admin writes.

2603

#

2604

# Note: `AuditConfig` doesn't apply to "admin activity", which always

2605

# enables audit logging.

2606

{ # Enables "data access" audit logging for a service and specifies a list

2607

# of members that are log-exempted.

2608

"exemptedMembers": [ # Specifies the identities that are exempted from "data access" audit

2609

# logging for the `service` specified above.

2610

# Follows the same format of Binding.members.

2611

"A String",

2612

],

2613

"service": "A String", # Specifies a service that will be enabled for "data access" audit

2614

# logging.

2615

# For example, `resourcemanager`, `storage`, `compute`.

2616

# `allServices` is a special value that covers all services.

2617

},

2618

],

2619

"rules": [ # If more than one rule is specified, the rules are applied in the following

2620

# manner:

2621

# - All matching LOG rules are always applied.

2622

# - If any DENY/DENY_WITH_LOG rule matches, permission is denied.

2623

# Logging will be applied if one or more matching rule requires logging.

2624

# - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is

2625

# granted.

2626

# Logging will be applied if one or more matching rule requires logging.

2627

# - Otherwise, if no rule applies, permission is denied.

2628

{ # A rule to be applied in a Policy.

2629

"notIn": [ # If one or more 'not_in' clauses are specified, the rule matches

2630

# if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2631

# The format for in and not_in entries is the same as for members in a

2632

# Binding (see google/iam/v1/policy.proto).

2633

"A String",

2634

],

2635

"description": "A String", # Human-readable description of the rule.

2636

"in": [ # If one or more 'in' clauses are specified, the rule matches if

2637

# the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2638

"A String",

2639

],

2640

"action": "A String", # Required

2641

"conditions": [ # Additional restrictions that must be met

2642

{ # A condition to be met.

2643

"iam": "A String", # Trusted attributes supplied by the IAM system.

2644

"svc": "A String", # Trusted attributes discharged by the service.

2645

"value": "A String", # DEPRECATED. Use 'values' instead.

2646

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses

2647

# the IAM system for access control.

2648

"values": [ # The objects of the condition. This is mutually exclusive with 'value'.

2649

"A String",

2650

],

2651

"op": "A String", # An operator to apply the subject with.

2652

},

2653

],

2654

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries

2655

# that match the LOG action.

2656

{ # Specifies what kind of log the caller must write

2657

# Increment a streamz counter with the specified metric and field names.

2658

#

2659

# Metric names should start with a '/', generally be lowercase-only,

2660

# and end in "_count". Field names should not contain an initial slash.

2661

# The actual exported metric names will have "/iam/policy" prepended.

2662

#

2663

# Field names correspond to IAM request parameters and field values are

2664

# their respective values.

2665

#

2666

# At present the only supported field names are

2667

# - "iam_principal", corresponding to IAMContext.principal;

2668

# - "" (empty string), resulting in one aggretated counter with no field.

2669

#

2670

# Examples:

2671

# counter { metric: "/debug_access_count" field: "iam_principal" }

2672

# ==> increment counter /iam/policy/backend_debug_access_count

2673

# {iam_principal=[value of IAMContext.principal]}

2674

#

2675

# At this time we do not support:

2676

# * multiple field names (though this may be supported in the future)

2677

# * decrementing the counter

2678

# * incrementing it by anything other than 1

2679

"counter": { # Options for counters # Counter options.

2680

"field": "A String", # The field value to attribute.

2681

"metric": "A String", # The metric to update.

2682

},

2683

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2684

},

2685

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

},

},

],

"permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'

2690

# (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,

2691

# and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Version of the `Policy`. The default version is 0.

2697

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

2698

# prevent simultaneous updates of a policy from overwriting each other.

2699

# It is strongly suggested that systems make use of the `etag` in the

2700

# read-modify-write cycle to perform policy updates in order to avoid race

2701

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

2702

# systems are expected to put that etag in the request to `setIamPolicy` to

2703

# ensure that their change will be applied to the same version of the policy.

2704

#

2705

# If no `etag` is provided in the call to `setIamPolicy`, then the existing

2706

# policy is overwritten blindly.

2707

"bindings": [ # Associates a list of `members` to a `role`.

2708

# Multiple `bindings` must not be specified for the same `role`.

2709

# `bindings` with no members will result in an error.

2710

{ # Associates `members` with a `role`.

2711

"role": "A String", # Role that is assigned to `members`.

2712

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2713

# Required

2714

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

2715

# `members` can have the following values:

2716

#

2717

# * `allUsers`: A special identifier that represents anyone who is

2718

# on the internet; with or without a Google account.

2719

#

2720

# * `allAuthenticatedUsers`: A special identifier that represents anyone

2721

# who is authenticated with a Google account or a service account.

2722

#

2723

# * `user:{emailid}`: An email address that represents a specific Google

2724

# account. For example, `alice@gmail.com` or `joe@example.com`.

2725

#

2726

# * `serviceAccount:{emailid}`: An email address that represents a service

2727

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

2728

#

2729

# * `group:{emailid}`: An email address that represents a Google group.

2730

# For example, `admins@example.com`.

2731

#

2732

# * `domain:{domain}`: A Google Apps domain name that represents all the

2733

# users of that domain. For example, `google.com` or `example.com`.

#

"A String",

],

},

],

"iamOwned": True or False,

}</pre>

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>

2745

<pre>Returns permissions that a caller has on the specified resource.

2746

2747

Args:

2748

resource: string, REQUIRED: The resource for which the policy detail is being requested.

2749

`resource` is usually specified as a path. For example, a Project

2750

resource is specified as `projects/{project}`. (required)

2751

body: object, The request body. (required)

2752

The object takes the form of:

2753

2754

{ # Request message for `TestIamPermissions` method.

2755

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

2756

# wildcards (such as '*' or 'storage.*') are not allowed. For more

2757

# information see

2758

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2770

2771

{ # Response message for `TestIamPermissions` method.

2772

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

# allowed.

"A String",

],

}</pre>

</div>

<code class="details" id="undelete">undelete(serviceName=None, x__xgafv=None)</code>

2781

<pre>Revives a previously deleted managed service. The method restores the

2782

service using the configuration at the time the service was deleted.

2783

The target service must exist and must have been deleted within the

2784

last 30 days.

2785

2786

Operation<response: UndeleteServiceResponse>

2787

2788

Args:

2789

serviceName: string, The name of the service. See the [overview](/service-management/overview)

2790

for naming requirements. For example: `example.googleapis.com`. (required)

2791

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2798

2799

{ # This resource represents a long-running operation that is the result of a

2800

# network API call.

2801

"metadata": { # Service-specific metadata associated with the operation. It typically

2802

# contains progress information and common metadata such as create time.

2803

# Some services might not provide such metadata. Any method that returns a

2804

# long-running operation should document the metadata type, if any.

2805

"a_key": "", # Properties of the object. Contains field @type with type URL.

2806

},

2807

"done": True or False, # If the value is `false`, it means the operation is still in progress.

2808

# If true, the operation is completed, and either `error` or `response` is

2809

# available.

2810

"response": { # The normal response of the operation in case of success. If the original

2811

# method returns no data on success, such as `Delete`, the response is

2812

# `google.protobuf.Empty`. If the original method is standard

2813

# `Get`/`Create`/`Update`, the response should be the resource. For other

2814

# methods, the response should have the type `XxxResponse`, where `Xxx`

2815

# is the original method name. For example, if the original method name

2816

# is `TakeSnapshot()`, the inferred response type is

2817

# `TakeSnapshotResponse`.

2818

"a_key": "", # Properties of the object. Contains field @type with type URL.

2819

},

2820

"name": "A String", # The server-assigned name, which is only unique within the same service that

2821

# originally returns it. If you use the default HTTP mapping, the

2822

# `name` should have the format of `operations/some/unique/name`.

2823

"error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.

2824

# programming environments, including REST APIs and RPC APIs. It is used by

2825

# [gRPC](https://github.com/grpc). The error model is designed to be:

2826

#

2827

# - Simple to use and understand for most users

2828

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error message,

2833

# and error details. The error code should be an enum value of

2834

# google.rpc.Code, but it may accept additional error codes if needed. The

2835

# error message should be a developer-facing English message that helps

2836

# developers *understand* and *resolve* the error. If a localized user-facing

2837

# error message is needed, put the localized message in the error details or

2838

# localize it in the client. The optional error details may contain arbitrary

2839

# information about the error. There is a predefined set of error detail types

2840

# in the package `google.rpc` which can be used for common error conditions.

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

2845

# is not necessarily the actual wire format. When the `Status` message is

2846

# exposed in different client libraries and different wire protocols, it can be

2847

# mapped differently. For example, it will likely be mapped to some exceptions

2848

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

2853

# environments, either with or without APIs, to provide a

2854

# consistent developer experience across different environments.

2855

#

2856

# Example uses of this error model include:

2857

#

2858

# - Partial errors. If a service needs to return partial errors to the client,

2859

# it may embed the `Status` in the normal response to indicate the partial

2860

# errors.

2861

#

2862

# - Workflow errors. A typical workflow has multiple steps. Each step may

2863

# have a `Status` message for error reporting purpose.

2864

#

2865

# - Batch operations. If a client uses batch request and batch response, the

2866

# `Status` message should be used directly inside batch response, one for

2867

# each error sub-response.

2868

#

2869

# - Asynchronous operations. If an API call embeds asynchronous operation

2870

# results in its response, the status of those operations should be

2871

# represented directly using the `Status` message.

2872

#

2873

# - Logging. If some API errors are stored in logs, the message `Status` could

2874

# be used directly after any stripping needed for security/privacy reasons.

2875

"message": "A String", # A developer-facing error message, which should be in English. Any

2876

# user-facing error message should be localized and sent in the

2877

# google.rpc.Status.details field, or localized by the client.

2878

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2879

"details": [ # A list of messages that carry the error details. There will be a

2880

# common set of message types for APIs to use.

2881

{

2882

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

}</pre>

</div>

</body></html>